Package org.bluezoo.gumdrop.telemetry.json

Class OTLPFileExporter

java.lang.Object

org.bluezoo.gumdrop.telemetry.json.OTLPFileExporter

All Implemented Interfaces:

TelemetryExporter

public class OTLPFileExporter
extends Object
implements TelemetryExporter

Exports telemetry data to OTLP JSON Lines files or stdout.

This exporter implements the OpenTelemetry Protocol File Exporter specification. Each line written is a complete OTLP JSON object (ExportTraceServiceRequest, ExportLogsServiceRequest, or ExportMetricsServiceRequest) followed by a newline character.

When configured with file paths, separate .jsonl files are maintained for each signal type (traces, logs, metrics) as required by the specification. When writing to stdout (the default), all signals share the same output stream.

Like the OTLP/HTTP exporter, data is queued and flushed by a background thread to avoid blocking the caller.

Configuration

 <component id="telemetry" class="org.bluezoo.gumdrop.telemetry.TelemetryConfig">
     <property name="service-name">my-service</property>
     <property name="exporter-type">file</property>
     <property name="file-traces-path">/var/log/otel/traces.jsonl</property>
     <property name="file-logs-path">/var/log/otel/logs.jsonl</property>
     <property name="file-metrics-path">/var/log/otel/metrics.jsonl</property>
     <property name="file-buffer-size">8192</property>
 </component>
 

Author:

Chris Burdess

Constructor Summary

Constructors

Constructor	Description
OTLPFileExporter(TelemetryConfig config)	Creates a file exporter that writes all signals to stdout.
OTLPFileExporter(TelemetryConfig config, Path tracesPath, Path logsPath, Path metricsPath)	Creates a file exporter that writes to the specified file paths.

Method Summary

Modifier and Type	Method	Description
void	export(List<MetricData> metrics)	Exports a batch of metric data.
void	export(LogRecord record)	Exports a log record.
void	export(Trace trace)	Exports a completed trace.
void	flush()	Flushes any buffered telemetry data.
void	shutdown()	Shuts down the exporter, releasing any resources.

Methods inherited from class java.lang.Object

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

Constructor Details

OTLPFileExporter

public OTLPFileExporter(TelemetryConfig config)

Creates a file exporter that writes all signals to stdout.

Parameters:

config - the telemetry configuration

OTLPFileExporter

public OTLPFileExporter(TelemetryConfig config,
 Path tracesPath,
 Path logsPath,
 Path metricsPath)

Creates a file exporter that writes to the specified file paths. Any null path causes that signal to be written to stdout.

Parameters:

config - the telemetry configuration

tracesPath - path for traces JSONL file, or null for stdout

logsPath - path for logs JSONL file, or null for stdout

metricsPath - path for metrics JSONL file, or null for stdout

Method Details

export

public void export(Trace trace)

Description copied from interface: TelemetryExporter

Exports a completed trace.

Specified by:

export in interface TelemetryExporter

Parameters:

trace - the trace to export

export

public void export(LogRecord record)

Description copied from interface: TelemetryExporter

Exports a log record.

Specified by:

export in interface TelemetryExporter

Parameters:

record - the log record to export

export

public void export(List<MetricData> metrics)

Description copied from interface: TelemetryExporter

Exports a batch of metric data.

Specified by:

export in interface TelemetryExporter

Parameters:

metrics - the metrics to export

flush

public void flush()

Description copied from interface: TelemetryExporter

Flushes any buffered telemetry data. This method blocks until the flush is complete.

Specified by:

flush in interface TelemetryExporter

shutdown

public void shutdown()

Description copied from interface: TelemetryExporter

Shuts down the exporter, releasing any resources.

Specified by:

shutdown in interface TelemetryExporter