org.apache.skywalking.oap.query.graphql.resolver

Class MetricsQuery

java.lang.Object

org.apache.skywalking.oap.query.graphql.resolver.MetricsQuery

All Implemented Interfaces:

com.coxautodev.graphql.tools.GraphQLQueryResolver, com.coxautodev.graphql.tools.GraphQLResolver<Void>

public class MetricsQuery
extends Object
implements com.coxautodev.graphql.tools.GraphQLQueryResolver

Metrics v2 query protocol implementation.

Since:

8.0.0

Constructor Summary

Constructors

Constructor and Description
MetricsQuery(org.apache.skywalking.oap.server.library.module.ModuleManager moduleManager)

Method Summary

Modifier and Type	Method and Description
List<MetricDefinition>	listMetrics(String regex) Get the list of all available metrics in the current OAP server.
HeatMap	readHeatMap(MetricsCondition condition, Duration duration) Heatmap is bucket based value statistic result.
List<MetricsValues>	readLabeledMetricsValues(MetricsCondition condition, List<String> labels, Duration duration) Read value in the given time duration, usually as a linear.
long	readMetricsValue(MetricsCondition condition, Duration duration) Read metrics single value in the duration of required metrics
MetricsValues	readMetricsValues(MetricsCondition condition, Duration duration) Read time-series values in the duration of required metrics
List<SelectedRecord>	readSampledRecords(TopNCondition condition, Duration duration) Read the sampled records.
List<SelectedRecord>	sortMetrics(TopNCondition condition, Duration duration) Read entity list of required metrics and parent entity type.
MetricsType	typeOfMetrics(String name) Metrics definition metadata query.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsQuery

public MetricsQuery(org.apache.skywalking.oap.server.library.module.ModuleManager moduleManager)

Method Detail

typeOfMetrics

public MetricsType typeOfMetrics(String name)
                          throws IOException

Metrics definition metadata query. Response the metrics type which determines the suitable query methods.

Throws:

IOException

listMetrics

public List<MetricDefinition> listMetrics(String regex)

Get the list of all available metrics in the current OAP server.

Parameters:

regex - to filter the metrics by name, if existing.

Returns:

all available metrics.

readMetricsValue

public long readMetricsValue(MetricsCondition condition,
                             Duration duration)
                      throws IOException

Read metrics single value in the duration of required metrics

Throws:

IOException

readMetricsValues

public MetricsValues readMetricsValues(MetricsCondition condition,
                                       Duration duration)
                                throws IOException

Read time-series values in the duration of required metrics

Throws:

IOException

sortMetrics

public List<SelectedRecord> sortMetrics(TopNCondition condition,
                                        Duration duration)
                                 throws IOException

Read entity list of required metrics and parent entity type.

Throws:

IOException

readLabeledMetricsValues

public List<MetricsValues> readLabeledMetricsValues(MetricsCondition condition,
                                                    List<String> labels,
                                                    Duration duration)
                                             throws IOException

Read value in the given time duration, usually as a linear.

Parameters:

labels - the labels you need to query.

Throws:

IOException

readHeatMap

public HeatMap readHeatMap(MetricsCondition condition,
                           Duration duration)
                    throws IOException

Heatmap is bucket based value statistic result.

Returns:

heapmap including the latency distribution HeatMap.getBuckets() HeatMap.HeatMapColumn#getValues() follows this rule.

      key = 0, represents [0, 100), value = count of requests in the latency range.
      key = 100, represents [100, 200), value = count of requests in the latency range.
      ...
      key = step * maxNumOfSteps, represents [step * maxNumOfSteps, MAX)
 

Throws:

IOException

readSampledRecords

public List<SelectedRecord> readSampledRecords(TopNCondition condition,
                                               Duration duration)
                                        throws IOException

Read the sampled records.

Throws:

IOException