Package io.mishmash.opentelemetry.server.collector

package io.mishmash.opentelemetry.server.collector

OpenTelemetry collectors

This package contains the main classes used to embed OpenTelemetry collectors. Use one or all of LogsCollector, MetricsCollector and TracesCollector to create an OTEL data source for your system.

To use them:

1. Instantiate one of the collectors
2. Implement one or more subscribers - LogsSubscriber, MetricsSubscriber, SpansSubscriber to receive incoming OpenTelemetry signals of a given type
3. Subscribe them to the collector - SubmissionPublisher.subscribe(java.util.concurrent.Flow.Subscriber)
4. Setup gRPC and HTTP Vert.x servers and bind the collector to them - AbstractCollector.bind(io.vertx.grpc.server.GrpcServer) and AbstractCollector.bind(io.vertx.ext.web.Router).

When OTLP clients connect to the server and submit data - each individual data item in them - a log entry, a metric data point or a span - will be delivered to the subscribers' LogsSubscriber.onNext(Log), MetricsSubscriber.onNext(MetricDataPoint) or SpansSubscriber.onNext(Span) where you can make it available within the system you're embedding into.

This package is part of a broader set of OpenTelemetry-related activities at mishmash io. To find out more about this and other packages visit the links below.

See Also:

• OpenTelemetry at mishmash io
• This package on GitHub
• mishmash io

Class	Description
AbstractCollector<REQ extends com.google.protobuf.AbstractMessage,RESP extends com.google.protobuf.AbstractMessage,RECORD>	This class handles the OTLP protocol for gRPC and HTTP transports for a collector of a given signal type (like logs, metrics or traces).
Batch<T>	Contains a number of elements that should be processed together, and in parallel, but actual processing might happen at different paces.
GrpcCollectorException	An Exception that also contains the GrpcStatus that should be returned to the client.
Instrumentation	A simple class with helper methods for OpenTelemetry embedded collectors own telemetry.
Log	Holds the details of an individual OTLP log record received from a client as a Batch of all subscribers that are expected to process it.
LogsCollector	Processes incoming OpenTelemetry logs packets - extracts individual Logs from a packet and queues them to all LogsSubscribers.
LogsSubscriber	A Flow.Subscriber for OpenTelemetry Log records.
MetricDataPoint	Holds the details of an individual OTLP metric data point received from a client as a Batch of all subscribers that are expected to process it.
MetricsCollector	Processes incoming OpenTelemetry metrics packets - extracts all data points of all metrics contained in a packet and queues them to all MetricsSubscribers.
MetricsSubscriber	A Flow.Subscriber for OpenTelemetry MetricDataPoint records.
Span	Holds the details of an individual OTLP span record received from a client as a Batch of all subscribers that are expected to process it.
SpansSubscriber	A Flow.Subscriber for OpenTelemetry Span records.
SubscribersBatch<T>	A 'batch' of all LogsSubscribers, MetricsSubscribers or @{link SpansSubscribers} that were given the task to process an OpenTelemetry log record, metric data point or trace span.
TracesCollector	Processes incoming OpenTelemetry traces packets - extracts individual Spans from a packet and queues them to all SpansSubscribers.
VertxInputStream	An InputStream that takes a Vert.x ReadStream and reads it up to a given number of bytes.