com.griddynamics.jagger.engine.e1.collector.MetricDescription Class Reference

Class to describe metric. More...

Inheritance diagram for com.griddynamics.jagger.engine.e1.collector.MetricDescription:

Public Member Functions
MetricDescription	addAggregator (MetricAggregatorProvider aggregator)
	Append new aggregator to list of metric aggregator. More...
MetricDescription	addAggregator (MetricAggregatorProvider aggregator, MetricAggregatorSettings settings)
	Append new aggregator to list of metric aggregator with settings. More...
MetricDescription	displayName (String displayName)
	Setter for metric display name. More...
List< MetricAggregatorProvider >	getAggregators ()
	Getter for metric aggregators. More...
Map< MetricAggregatorProvider, MetricAggregatorSettings >	getAggregatorsWithSettings ()
	Getter for metric aggregators with settings. More...
String	getDisplayName ()
	Getter for metric display name. More...
String	getMetricId ()
	Getter for metric ID. More...
boolean	getPlotData ()
	Getter for metric "plot data" boolean parameter. More...
boolean	getShowSummary ()
	Getter for metric "show summary" boolean parameter. More...
	MetricDescription (String metricId)
	Constructor. More...
MetricDescription	plotData (boolean plotData)
	Setter for metric "plot data" boolean parameter. More...
void	setAggregators (List< MetricAggregatorProvider > aggregators)
	Setter for metric aggregators. More...
void	setAggregatorsWithSettings (Map< MetricAggregatorProvider, MetricAggregatorSettings > aggregatorsWithSettings)
	Setter for metric aggregators with settings. More...
void	setDisplayName (String displayName)
	Setter for metric display name. More...
void	setMetricId (String metricId)
	Setter for metric ID. More...
void	setPlotData (boolean plotData)
	Setter for metric "plot data" boolean parameter. More...
void	setShowSummary (boolean showSummary)
	Setter for metric "show summary" boolean parameter. More...
MetricDescription	showSummary (boolean showSummary)
	Setter for metric "show summary" boolean parameter. More...

Protected Attributes
Map< MetricAggregatorProvider, MetricAggregatorSettings >	aggregatorsWithSettings = Maps.newHashMap()
String	displayName
String	id
boolean	plotData
boolean	showSummary = true

Detailed Description

Class to describe metric.

Author

Gribov Kirill

Example of metric setup and creation with use of MetricService

        // begin: following section is used for docu generation - example of metric creation

        // In this example, we will create custom metric to collect internal metrics of SUT
        // Approach is the following:
        // - Declare custom metric
        // - Run test. SUT will usually collect some internal data (metrics)
        // - After test is finished, get all internal data from SUT and save to custom metric
        // In this case internal data will be save to result DB, displayed in test report and Web UI,
        // you can use it in decision maker when running Continues Integration
        MetricDescription metricDescription = new MetricDescription("internalData");
        metricDescription.plotData(false).showSummary(true).addAggregator(new AvgMetricAggregatorProvider());
        getMetricService().createMetric(metricDescription);

        // end: following section is used for docu generation - example of metric creation

---

The documentation for this class was generated from the following file:

• chassis/core/src/main/java/com/griddynamics/jagger/engine/e1/collector/MetricDescription.java