Class GrafanaMetricsAnnotator

java.lang.Object

io.nosqlbench.engine.clients.grafana.annotator.GrafanaMetricsAnnotator

All Implemented Interfaces:

Annotator, NBCanConfigure, NBConfigModelProvider, NBConfigurable

public class GrafanaMetricsAnnotator
extends Object
implements Annotator, NBConfigurable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrafanaMetricsAnnotator.AuthWrapper

Constructor Summary

Constructors

Constructor	Description
GrafanaMetricsAnnotator()

Method Summary

Modifier and Type	Method	Description
void	applyConfig(NBConfiguration cfg)	Implementors should take care to ensure that this can be called after initial construction without unexpected interactions between construction parameters and configuration parameters.
NBConfigModel	getConfigModel()	Implement this method by returning an instance of ConfigModel.
void	recordAnnotation(Annotation annotation)	Submit an annotation to some type of annotation store, logging or eventing mechanism.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GrafanaMetricsAnnotator

public GrafanaMetricsAnnotator()

Method Details

recordAnnotation

public void recordAnnotation(Annotation annotation)

Description copied from interface: Annotator

Submit an annotation to some type of annotation store, logging or eventing mechanism. Implementations of this service are responsible for mapping the scenario and labels into appropriate key data, and the details in to a native payload. The least surprising and most obvious mapping should be used in each case.

For details on constructing a useful annotation to submit to this service, see Annotation.newBuilder()

Specified by:

recordAnnotation in interface Annotator

applyConfig

public void applyConfig(NBConfiguration cfg)

Description copied from interface: NBConfigurable

Implementors should take care to ensure that this can be called after initial construction without unexpected interactions between construction parameters and configuration parameters.

Specified by:

applyConfig in interface NBCanConfigure

Specified by:

applyConfig in interface NBConfigurable

Parameters:

cfg - The configuration data to be applied to a new instance

getConfigModel

public NBConfigModel getConfigModel()

Description copied from interface: NBConfigurable

Implement this method by returning an instance of ConfigModel. Any configuration which is provided to the NBConfigurable.applyConfig(NBConfiguration) method will be validated through this model. A configuration model is required in order to build a validated configuration from source data provided by a user.

Specified by:

getConfigModel in interface NBConfigModelProvider

Specified by:

getConfigModel in interface NBConfigurable

Returns:

A valid configuration model for the implementing class