Package org.jenkinsci.plugins.octoperf.metrics

Interface MetricsService

public interface MetricsService

Retrieve test metrics from remote servers.

Author:

jerome

Field Summary

Fields

Modifier and Type	Field	Description
static final MetricsService	METRICS	MetricsService singleton instance.

Method Summary

Modifier and Type	Method	Description
MetricValues	getMetrics(RestApiFactory apiFactory, String benchResultId)	Retrieves current test metrics from the server.
String	toPrintable(org.joda.time.DateTime startTime, MetricValues metrics)	Converts the metrics into a human readable line of values

Field Details

METRICS

static final MetricsService METRICS

MetricsService singleton instance.

Method Details

getMetrics

MetricValues getMetrics(RestApiFactory apiFactory,
 String benchResultId)
                 throws IOException

Retrieves current test metrics from the server. The returned metrics are test-wide metrics.

Parameters:

apiFactory - rest retrofit

benchResultId - bench result id

Returns:

global test metrics.

Throws:

IOException

toPrintable

String toPrintable(org.joda.time.DateTime startTime,
 MetricValues metrics)

Converts the metrics into a human readable line of values

Parameters:

startTime - test start time

metrics - metrics to print

Returns:

printable output