com.github.johrstrom.collector

Class BaseCollectorConfig

java.lang.Object

org.apache.jmeter.testelement.AbstractTestElement

com.github.johrstrom.collector.BaseCollectorConfig

All Implemented Interfaces:

Serializable, Cloneable, org.apache.jmeter.gui.Searchable, org.apache.jmeter.testelement.TestElement

Direct Known Subclasses:

ListenerCollectorConfig

public class BaseCollectorConfig
extends org.apache.jmeter.testelement.AbstractTestElement

The base class for turning text/strings (from the JMeter GUI, or a .jmx file, etc.) into Prometheus Collector objects. Along with being a TestElement so that it can be serialized (for the .jmx file) it also handles all the logic of parsing strings into double arrays. There are also static utility functions to actually instantiate a Collector of a given type from a configuration. buckets are comma seperated list of decimals. An example: 100,200,300,400.3 quantiles are comma seperated pair of decimals seperated by |. The first decimal being the quantile and the second being the error rating. An example: 0.999,0.1|0.99,0.2|0.75,0.3

Author:

Jeff Ohrstrom

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseCollectorConfig.JMeterCollectorType
static class	BaseCollectorConfig.QuantileDefinition A very simple POJO for holding Quantiles and the error rating for them.

Field Summary

Fields

Modifier and Type	Field and Description
static double[]	DEFAULT_BUCKET_SIZES
static String	DEFAULT_BUCKET_SIZES_STRING
static String	DEFAULT_HELP_STRING
static BaseCollectorConfig.QuantileDefinition[]	DEFAULT_QUANTILES
static String	DEFAULT_QUANTILES_STRING
static String	HELP
static String	LABELS
static String	METRIC_NAME_BASE
static String	NAME
static String	QUANTILES_OR_BUCKETS
static String	TYPE

Fields inherited from interface org.apache.jmeter.testelement.TestElement

COMMENTS, ENABLED, GUI_CLASS, TEST_CLASS

Constructor Summary

Constructors

Constructor and Description
BaseCollectorConfig()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static io.prometheus.client.Collector	fromConfig(BaseCollectorConfig cfg)
double[]	getBuckets()
BaseCollectorConfig.JMeterCollectorType	getCollectorType()
String	getHelp()
String[]	getLabels()
String	getLabelsAsString()
String	getMetricName()
String	getQuantileOrBucket()
BaseCollectorConfig.QuantileDefinition[]	getQuantiles()
String	getRandomMetricName()
String	getType()
int	hashCode()
static io.prometheus.client.Counter	newCounter(BaseCollectorConfig cfg)
static io.prometheus.client.Gauge	newGauge(BaseCollectorConfig cfg)
static io.prometheus.client.Histogram	newHistogram(BaseCollectorConfig cfg)
static io.prometheus.client.Summary	newSummary(BaseCollectorConfig cfg)
protected double[]	parseBucketsFromString(String fullBucketString)
void	setHelp(String help)
void	setLabels(String labels)
void	setLabels(String[] labels)
void	setMetricName(String name)
void	setQuantileOrBucket(String quantileOrBucket)
void	setType(String type)
String	toString()

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jmeter.testelement.TestElement

removed

Field Detail

HELP

public static String HELP

NAME

public static String NAME

TYPE

public static String TYPE

LABELS

public static String LABELS

QUANTILES_OR_BUCKETS

public static String QUANTILES_OR_BUCKETS

DEFAULT_BUCKET_SIZES

public static double[] DEFAULT_BUCKET_SIZES

DEFAULT_BUCKET_SIZES_STRING

public static String DEFAULT_BUCKET_SIZES_STRING

DEFAULT_QUANTILES

public static BaseCollectorConfig.QuantileDefinition[] DEFAULT_QUANTILES

DEFAULT_QUANTILES_STRING

public static String DEFAULT_QUANTILES_STRING

DEFAULT_HELP_STRING

public static String DEFAULT_HELP_STRING

METRIC_NAME_BASE

public static String METRIC_NAME_BASE

Constructor Detail

BaseCollectorConfig

public BaseCollectorConfig()

Method Detail

getHelp

public String getHelp()

setHelp

public void setHelp(String help)

getType

public String getType()

getCollectorType

public BaseCollectorConfig.JMeterCollectorType getCollectorType()

setType

public void setType(String type)

getQuantileOrBucket

public String getQuantileOrBucket()

setQuantileOrBucket

public void setQuantileOrBucket(String quantileOrBucket)

getBuckets

public double[] getBuckets()

getQuantiles

public BaseCollectorConfig.QuantileDefinition[] getQuantiles()

getMetricName

public String getMetricName()

setMetricName

public void setMetricName(String name)

getRandomMetricName

public String getRandomMetricName()

setLabels

public void setLabels(String labels)

setLabels

public void setLabels(String[] labels)

getLabels

public String[] getLabels()

getLabelsAsString

public String getLabelsAsString()

newCounter

public static io.prometheus.client.Counter newCounter(BaseCollectorConfig cfg)
                                               throws Exception

Throws:

Exception

newSummary

public static io.prometheus.client.Summary newSummary(BaseCollectorConfig cfg)
                                               throws Exception

Throws:

Exception

newHistogram

public static io.prometheus.client.Histogram newHistogram(BaseCollectorConfig cfg)
                                                   throws Exception

Throws:

Exception

newGauge

public static io.prometheus.client.Gauge newGauge(BaseCollectorConfig cfg)
                                           throws Exception

Throws:

Exception

fromConfig

public static io.prometheus.client.Collector fromConfig(BaseCollectorConfig cfg)

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.jmeter.testelement.AbstractTestElement

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.jmeter.testelement.AbstractTestElement

toString

public String toString()

Overrides:

toString in class Object

parseBucketsFromString

protected double[] parseBucketsFromString(String fullBucketString)