Package io.mishmash.opentelemetry.server.collector

Class MetricsCollector

java.lang.Object

java.util.concurrent.SubmissionPublisher<RECORD>

io.mishmash.opentelemetry.server.collector.AbstractCollector<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse,MetricDataPoint>

io.mishmash.opentelemetry.server.collector.MetricsCollector

All Implemented Interfaces:

AutoCloseable, Flow.Publisher<MetricDataPoint>

public class MetricsCollector
extends AbstractCollector<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse,MetricDataPoint>

Processes incoming OpenTelemetry metrics packets - extracts all data points of all metrics contained in a packet and queues them to all MetricsSubscribers. Also notifies the client on potential errors.

Field Summary

Fields inherited from class io.mishmash.opentelemetry.server.collector.AbstractCollector

DEFAULT_CLOSE_TIMETOUT_SEC, DEFAULT_MAX_BODY_LEN, DEFAULT_SUBSCRIBER_QUEUE_SIZE, DEFAULT_TIMEOUT_SEC, HTTP_BAD_GATEWAY, HTTP_BAD_REQUEST, HTTP_EXPECTATION_FAILED, HTTP_GATEWAY_TIMEOUT, HTTP_INTERNAL_ERROR, HTTP_OK, HTTP_PAYLOAD_TOO_LARGE, HTTP_SERVICE_UNAVAILABLE, HTTP_TOO_MANY_REQUESTS

Constructor Summary

Constructors

Constructor	Description
MetricsCollector(io.grpc.MethodDescriptor<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse> exportMethod, Instrumentation otel)	Creates a new metrics collector to be added to a Vert.x routing context.

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse	getBatchResponse(io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest request, Batch<MetricDataPoint> completedBatch, String transport, String encoding)	Called to compute the correct response to the client after an entire batch (or packet) of OpenTelemetry logs, metrics or spans has been processed.
Batch<MetricDataPoint>	loadBatch(io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest request, String transport, String encoding, io.opentelemetry.context.Context otelContext)	Processes incoming packets (or batches) - extracts and publishes the contained OpenTelemetry metric data points (one by one) to all MetricsSubscribers.
protected boolean	offerDataPoint(Batch<MetricDataPoint> batch, MetricDataPoint m, String uuid, String transport, String encoding)	Actually sumbit a data point to all subscribers.
protected String	telemetrySignalType()	Returns "metrics" as the signal type for this collector's own telemetry.

Methods inherited from class io.mishmash.opentelemetry.server.collector.AbstractCollector

addDroppedRequestItems, addFailedRequests, addGrpcFailedRequests, addHttpFailedRequests, addPartiallySucceededRequests, addRequestItems, addRequestsInProcess, addSucceededRequests, bind, bind, checkBody, checkContentType, checkSubscribers, close, closeExceptionally, getErrorCode, getInstrumentation, getOtelContext, getOtelRequest, getOtelResponse, handle, httpEncoding, initInstrumentation, isError, isJsonContent, isJsonRequest, isProtobufContent, isRetryable, isRetryable, parseContentLengthHeader, parseHttpJson, parseHttpProtobuf, parseHttpRequest, publish, publish, respond, respond, responseToJson, responseToProtobuf, setErrorCode, setJsonRequest, setOtelContext, setOtelRequest, setOtelResponse

Methods inherited from class java.util.concurrent.SubmissionPublisher

consume, estimateMaximumLag, estimateMinimumDemand, getClosedException, getExecutor, getMaxBufferCapacity, getNumberOfSubscribers, getSubscribers, hasSubscribers, isClosed, isSubscribed, offer, offer, submit, subscribe

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsCollector

public MetricsCollector(io.grpc.MethodDescriptor<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse> exportMethod,
 Instrumentation otel)

Creates a new metrics collector to be added to a Vert.x routing context.

Parameters:

exportMethod - the gRPC method to be attached to

otel - a helper for own telemetry needs

Method Details

loadBatch

public Batch<MetricDataPoint> loadBatch(io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest request,
 String transport,
 String encoding,
 io.opentelemetry.context.Context otelContext)

Processes incoming packets (or batches) - extracts and publishes the contained OpenTelemetry metric data points (one by one) to all MetricsSubscribers.

Specified by:

loadBatch in class AbstractCollector<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse,MetricDataPoint>

Parameters:

request - the client's OTLP request

transport - the OTLP transport - "grpc" or "http"

encoding - the OTLP encoding - "protobuf" or "json"

otelContext - the Context used for own telemetry

Returns:

a new Batch with all items of the request

offerDataPoint

protected boolean offerDataPoint(Batch<MetricDataPoint> batch,
 MetricDataPoint m,
 String uuid,
 String transport,
 String encoding)

Actually sumbit a data point to all subscribers.

Parameters:

batch - the batch

m - the data point

uuid - id of the batch

transport - OTLP transport used

encoding - OTLP transport encoding used

Returns:

true if successful

getBatchResponse

public io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse getBatchResponse(io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest request,
 Batch<MetricDataPoint> completedBatch,
 String transport,
 String encoding)

Called to compute the correct response to the client after an entire batch (or packet) of OpenTelemetry logs, metrics or spans has been processed.

Specified by:

getBatchResponse in class AbstractCollector<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse,MetricDataPoint>

Parameters:

request - the original request from the client

completedBatch - the completed batch of records

transport - the OTLP transport used - "grpc" or "http"

encoding - - the OTLP encoding - "protobuf" or "json"

Returns:

the correct OTLP reposne to be sent back to the client

telemetrySignalType

protected String telemetrySignalType()

Returns "metrics" as the signal type for this collector's own telemetry.

Specified by:

telemetrySignalType in class AbstractCollector<io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceRequest,io.opentelemetry.proto.collector.metrics.v1.ExportMetricsServiceResponse,MetricDataPoint>

Returns:

the signal type