Package org.yamcs.prometheus

Class PrometheusApi

java.lang.Object

org.yamcs.prometheus.api.AbstractPrometheusApi<org.yamcs.http.Context>

org.yamcs.prometheus.PrometheusApi

All Implemented Interfaces:

org.yamcs.api.Api<org.yamcs.http.Context>

public class PrometheusApi
extends AbstractPrometheusApi<org.yamcs.http.Context>

Responds to HTTP requests with current metrics in the text-based Prometheus exposition format v0.0.4

Constructor Summary

Constructors

Constructor	Description
PrometheusApi(io.prometheus.client.CollectorRegistry registry)

Method Summary

Modifier and Type	Method	Description
void	getMetrics(org.yamcs.http.Context ctx, GetMetricsRequest request, org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)	Exports metrics in Prometheus text format

Methods inherited from class org.yamcs.prometheus.api.AbstractPrometheusApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusApi

public PrometheusApi(io.prometheus.client.CollectorRegistry registry)

Method Detail

getMetrics

public void getMetrics(org.yamcs.http.Context ctx,
                       GetMetricsRequest request,
                       org.yamcs.api.Observer<org.yamcs.api.HttpBody> observer)

Description copied from class: AbstractPrometheusApi

Exports metrics in Prometheus text format

Specified by:

getMetrics in class AbstractPrometheusApi<org.yamcs.http.Context>