Package jetbrains.buildServer.metrics

Interface ServerMetrics

All Known Subinterfaces:

ServerMetricsEx

All Known Implementing Classes:

ServerMetricsFactory

public interface ServerMetrics

Global server metrics reporter.

Since:

2019.2

Author:

kir

Method Summary

Modifier and Type	Method	Description
MetricBuilder	metricBuilder(String metricName)
MetricBuilder	projectMetricBuilder(String metricName, String projectExtId, String buildTypeExtId)	Creates a metric builder for a metric associated with a project, and optionally, with a build configuration.

Method Detail

metricBuilder

@NotNull
MetricBuilder metricBuilder(@NotNull
                            String metricName)

Parameters:

metricName - metric name, it should provide enough context so that if all records are selected just by name, the value can be meaningful. Use "." separator, like "started.builds"

projectMetricBuilder

MetricBuilder projectMetricBuilder(@NotNull
                                   String metricName,
                                   @NotNull
                                   String projectExtId,
                                   @Nullable
                                   String buildTypeExtId)

Creates a metric builder for a metric associated with a project, and optionally, with a build configuration. Project-scoped metrics have a separate query interface, and have a separate Prometheus endpoint. Such metrics should be reported not for all projects, but only for white-listed ones.

Parameters:

metricName - metric name, it should provide enough context so that if all records are selected just by name, the value can be meaningful. Use "." separator, like "started.builds"

projectExtId - project external ID, in the resulting metric is bound to projectId tag

buildTypeExtId - build configuration external ID, if present, bound to buildTypeId tag

Returns:

see above

Since:

2022.08

See Also:

MetricBuilder, ServerMetricsReader.projectQueryBuilder(Collection)