nosqlbench-1478 sanitize all labels which are used according to the openmetrics exposition format...

engine-core/src/main/java/io/nosqlbench/engine/core/lifecycle/activity/ActivityExecutor.java

@@ -15,6 +15,8 @@
  */
 package io.nosqlbench.engine.core.lifecycle.activity;
 
+import io.nosqlbench.api.config.NBLabeledElement;
+import io.nosqlbench.api.config.NBLabels;
 import io.nosqlbench.engine.api.activityapi.core.*;
 import io.nosqlbench.engine.api.activityimpl.MotorState;
 import io.nosqlbench.api.annotations.Annotation;
@@ -51,7 +53,7 @@ import java.util.stream.Collectors;
  * This allows the state tracking to work consistently for all observers.</p>
  */
 
-public class ActivityExecutor implements ActivityController, ParameterMap.Listener, ProgressCapable, Callable<ExecutionResult> {
+public class ActivityExecutor implements NBLabeledElement, ActivityController, ParameterMap.Listener, ProgressCapable, Callable<ExecutionResult> {
 
     // TODO Encapsulate valid state transitions to be only modifiable within the appropriate type view.
 
@@ -99,12 +101,9 @@ public class ActivityExecutor implements ActivityController, ParameterMap.Listen
         logger.info(() -> "stopped: " + this.getActivityDef().getAlias() + " with " + motors.size() + " slots");
 
         Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(sessionId)
+            .element(this)
             .interval(this.startedAt, this.stoppedAt)
             .layer(Layer.Activity)
-            .label("alias", getActivityDef().getAlias())
-            .label("driver", getActivityDef().getActivityType())
-            .label("workload", getActivityDef().getParams().getOptionalString("workload").orElse("none"))
             .detail("params", getActivityDef().toString())
             .build()
         );
@@ -126,12 +125,9 @@ public class ActivityExecutor implements ActivityController, ParameterMap.Listen
         logger.info(() -> "stopped: " + this.getActivityDef().getAlias() + " with " + motors.size() + " slots");
 
         Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(sessionId)
+                .element(this)
             .interval(this.startedAt, this.stoppedAt)
             .layer(Layer.Activity)
-            .label("alias", getActivityDef().getAlias())
-            .label("driver", getActivityDef().getActivityType())
-            .label("workload", getActivityDef().getParams().getOptionalString("workload").orElse("none"))
             .detail("params", getActivityDef().toString())
             .build()
         );
@@ -505,12 +501,9 @@ public class ActivityExecutor implements ActivityController, ParameterMap.Listen
 
         logger.info(() -> "starting activity " + activity.getAlias() + " for cycles " + activity.getCycleSummary());
         Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(sessionId)
+            .element(this)
             .now()
             .layer(Layer.Activity)
-            .label("alias", getActivityDef().getAlias())
-            .label("driver", getActivityDef().getActivityType())
-            .label("workload", getActivityDef().getParams().getOptionalString("workload").orElse("none"))
             .detail("params", getActivityDef().toString())
             .build()
         );
@@ -533,4 +526,8 @@ public class ActivityExecutor implements ActivityController, ParameterMap.Listen
     }
 
 
+    @Override
+    public NBLabels getLabels() {
+        return activity.getLabels();
+    }
 }

engine-core/src/main/java/io/nosqlbench/engine/core/lifecycle/scenario/Scenario.java

@@ -138,7 +138,7 @@ public class Scenario implements Callable<ExecutionMetricsResult>, NBLabeledElem
     }
 
     public static Scenario forTesting(final String name, final Engine engine, final String reportSummaryTo, final Maturity minMaturity) {
-        return new Scenario(name, null, engine, "console:10s", true, true, reportSummaryTo, "", Path.of("logs"), minMaturity, NBLabeledElement.forKV("test-name", "name"));
+        return new Scenario(name, null, engine, "console:10s", true, true, reportSummaryTo, "", Path.of("logs"), minMaturity, NBLabeledElement.forKV("test_name", "name"));
     }
 
     public Scenario setLogger(final Logger logger) {
@@ -249,7 +249,7 @@ public class Scenario implements Callable<ExecutionMetricsResult>, NBLabeledElem
         this.startedAtMillis = System.currentTimeMillis();
         Annotators.recordAnnotation(
             Annotation.newBuilder()
-                .session(scenarioName)
+                .element(this)
                 .now()
                 .layer(Layer.Scenario)
                 .detail("engine", engine.toString())
@@ -348,10 +348,10 @@ public class Scenario implements Callable<ExecutionMetricsResult>, NBLabeledElem
 
         // We report the scenario state via annotation even for short runs
         final Annotation annotation = Annotation.newBuilder()
-            .session(scenarioName)
+            .element(this)
             .interval(startedAtMillis, this.endedAtMillis)
             .layer(Layer.Scenario)
-            .label("state", state.toString())
+//            .labels("state", state.toString())
             .detail("command_line", commandLine)
             .build();
 

engine-core/src/main/java/io/nosqlbench/engine/core/lifecycle/scenario/ScenarioController.java

@@ -68,15 +68,6 @@ public class ScenarioController implements NBLabeledElement {
      * @param activityDef string in alias=value1;driver=value2;... format
      */
     public synchronized void start(ActivityDef activityDef) {
-        Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(scenario.getScenarioName())
-            .now()
-            .layer(Layer.Activity)
-            .label("alias", activityDef.getAlias())
-            .detail("command", "start")
-            .detail("params", activityDef.toString())
-            .build());
-
         doStartActivity(activityDef);
     }
 
@@ -84,6 +75,14 @@ public class ScenarioController implements NBLabeledElement {
     private synchronized ActivityRuntimeInfo doStartActivity(ActivityDef activityDef) {
         if (!this.activityInfoMap.containsKey(activityDef.getAlias())) {
             Activity activity = this.activityLoader.loadActivity(activityDef, this);
+
+            Annotators.recordAnnotation(Annotation.newBuilder()
+                .element(activity)
+                .now()
+                .layer(Layer.Activity)
+                .detail("params", activityDef.toString())
+                .build());
+
             ActivityExecutor executor = new ActivityExecutor(activity, this.scenario.getScenarioName());
             Future<ExecutionResult> startedActivity = activitiesExecutor.submit(executor);
             ActivityRuntimeInfo activityRuntimeInfo = new ActivityRuntimeInfo(activity, startedActivity, executor);
@@ -125,14 +124,6 @@ public class ScenarioController implements NBLabeledElement {
      * @param activityDef A definition for an activity to run
      */
     public synchronized void run(ActivityDef activityDef, long timeoutMs) {
-        Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(this.scenario.getScenarioName())
-            .now()
-            .layer(Layer.Activity)
-            .label("alias", activityDef.getAlias())
-            .detail("command", "run")
-            .detail("params", activityDef.toString())
-            .build());
 
         doStartActivity(activityDef);
         awaitActivity(activityDef, timeoutMs);
@@ -179,14 +170,6 @@ public class ScenarioController implements NBLabeledElement {
      * @param activityDef An activity def, including at least the alias parameter.
      */
     public synchronized void stop(ActivityDef activityDef) {
-        Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(this.scenario.getScenarioName())
-            .now()
-            .layer(Layer.Activity)
-            .label("alias", activityDef.getAlias())
-            .detail("command", "stop")
-            .detail("params", activityDef.toString())
-            .build());
 
         ActivityRuntimeInfo runtimeInfo = this.activityInfoMap.get(activityDef.getAlias());
         if (null == runtimeInfo) {
@@ -196,6 +179,14 @@ public class ScenarioController implements NBLabeledElement {
         scenariologger.debug("STOP {}", activityDef.getAlias());
 
         runtimeInfo.stopActivity();
+        Annotators.recordAnnotation(Annotation.newBuilder()
+            .element(runtimeInfo.getActivity())
+            .now()
+            .layer(Layer.Activity)
+            .detail("command", "stop")
+            .detail("params", activityDef.toString())
+            .build());
+
     }
 
     /**
@@ -240,20 +231,21 @@ public class ScenarioController implements NBLabeledElement {
      * @param activityDef An activity def, including at least the alias parameter.
      */
     public synchronized void forceStop(ActivityDef activityDef) {
-        Annotators.recordAnnotation(Annotation.newBuilder()
-            .session(this.scenario.getScenarioName())
-            .now()
-            .layer(Layer.Activity)
-            .label("alias", activityDef.getAlias())
-            .detail("command", "forceStop")
-            .detail("params", activityDef.toString())
-            .build());
 
         ActivityRuntimeInfo runtimeInfo = this.activityInfoMap.get(activityDef.getAlias());
+
         if (null == runtimeInfo) {
             throw new RuntimeException("could not force stop missing activity:" + activityDef);
         }
 
+        Annotators.recordAnnotation(Annotation.newBuilder()
+            .element(runtimeInfo.getActivity())
+            .now()
+            .layer(Layer.Activity)
+            .detail("command", "forceStop")
+            .detail("params", activityDef.toString())
+            .build());
+
         scenariologger.debug("FORCE STOP {}", activityDef.getAlias());
 
         runtimeInfo.forceStopActivity();