NAME

OpenTelemetry::Exporter::OTLP - An OpenTelemetry Protocol span exporter

SYNOPSIS

...

DESCRIPTION

This module provides a subclass of OpenTelemetry::Exporter which will export telemetry data using the OpenTelemetry Protocol (OTLP). It is the default exporter used by OpenTelemetry::SDK, and can be used to export data either using plain JSON strings, or binary protocol buffer blobs. See below for details.

METHODS

This class implements the OpenTelemetry::Exporter role. Please consult that module's documentation for details on the behaviours it provides.

new

$exporter = OpenTelemetry::Exporter::OTLP->new(
    certificate        => $file_path,           # optional
    client_certificate => $file_path,           # optional
    client_key         => $file_path,           # optional
    compression        => $compression,         # optional
    endpoint           => $url,                 # optional
    headers            => \%headers || $string, # optional
    protocol           => $protocol,            # optional
    timeout            => $seconds,             # optional
);

Constructs a new instance of the exporter. It takes the following named parameters, both of which are optional:

certificate

A string with the path to a file containing the trusted certificate to use when verifying a server's TLS credentials. If not set, this will be read from "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE", or "OTEL_EXPORTER_OTLP_CERTIFICATE" if that variable is not set.

If none of those values are set, this will remain undefined.

client_certificate

A string with the path to a file containing the client certificate/chain trust for the client's private key use in mTLS communication. The file should be in PEM format. If not set, this will be read from "OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE", or "OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE" if that variable is not set.

If none of those values are set, this will remain undefined.

client_key

A string with the path to a file containing the client's private key to use in mTLS communication. The file should be in PEM format. If not set, this will be read from "OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY", or "OTEL_EXPORTER_OTLP_CLIENT_KEY" if that variable is not set.

If none of those values are set, this will remain undefined.

compression

Controls if and how the exported data will be compressed before sending out. Possible values are "none", in which case no compression will be done, and "gzip", in which case that compression algorithm will be used.

If not set, the default value will be read from the "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION" environment variable, or "OTEL_EXPORTER_OTLP_COMPRESSION" if the first one is not set.

If none of these values is set, the default will depend on availability. If Compress::Zlib is installed, the compression will default to "gzip", otherwise none will be used.

If the value is set to a value other than the ones laid out above, construction will throw an OpenTelemetry::X::Unsupported exception.

endpoint

Specifies the target URL to which exported data will be sent. If set, it must be set to a valid URL with scheme and host. It may include a port, and should contain a path, but must not contain any additional parts.

Although the OTLP exporter specification specifies that endpoints should be signal-specific, this currently only applies to traces, since this exporter currently only supports exporting tracing data.

If not set, a default value will be read from "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT". If this is set, it will be used as-is.

If that value was not set, the "/v1/traces" path will be added to a base URL read from "OTEL_EXPORTER_OTLP_ENDPOINT". If this environment variable was not set, this base URL will default to "http://localhost:4318".

headers

A set of key/value pairs to send as headers for the HTTP request. This value can be set to either a hash reference with the desired key value pairs, or to a string in a format matching the W3C Correlation-Context, except that additional semi-colon delimited metadata is not allowed, as described in the OTLP exporter specification.

This would be a valid example: key1=value1,key2=value2.

When parsing this string, both keys and values will be independently URL-decoded and leading and trailing whitespace will be trimmed.

If this parameter is not set, it will be read from the "OTEL_EXPORTER_OTLP_TRACES_HEADERS" environment variable, or "OTEL_EXPORTER_OTLP_HEADERS" if the first one is not set.

If none of these is set, it will default to an empty hash.

protocol

OTLP supports multiple protocols. This exporter currently supports only "http/json", which exports data as a JSON string over HTTP, and "http/protobuf", which exports it as a Protobuf-encoded binary blob.

This parameter can be set to either of them to control which encoding to use. If not set, the default value will be read from the "OTEL_EXPORTER_OTLP_PROTOCOL" environment variable.

If a value is not set in the environment value, the default value will depend on availability. If Google::ProtocolBuffers::Dynamic is installed, the protocol will default to "http/protobuf". Otherwise the exporter will fall back to "http/json", using whatever encoding back-end is provided by JSON::MaybeXS.

If the value is set to a value other than the ones laid out above, construction will throw an OpenTelemetry::X::Unsupported exception.

timeout

The maximum number of seconds to wait before disconnecting. Note that although the specification suggests this should apply to the entire request, this currently applies to each individual open, read, or write operation on the socket.

If not set, this value will be read from "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT", or from "OTEL_EXPORTER_OTLP_TIMEOUT" if that variable is not set.

If none of these values is set, this will default to 10.

METRICS

This exporter generates a number of metrics to keep track of its regular operation. At the time of writing, these metrics are non-standard, but their inclusion in the standard is being discussed.

otel.otlp_exporter.failure

Incremented every time an error is encountered during export.

Reported with the following attributes:

reason

timeout

The connection to the collector timed out.

socket_error

There was a socket-related error while sending the data to the collector. This could be that the socket couldn't be opened, or closed, or written to, or otherwise properly configured.

ssl_error

There was an error either establishing an SSL connection, or terminating a previous SSL connection.

eof_error

There was an unexpected end of stream.

parse_error

There was an error parsing the URL to send the exported data to.

zlib_error

An error was encountered when compressing payload.

HTTP status code

An error was encountered when calling the export endpoint. The reason will be set to the non-successful numeric status code received from the server.

otel.otlp_exporter.message.compressed_size

Set to the size of the request content after compression is done. This is not sent if no compression is done.

otel.otlp_exporter.message.uncompressed_size

Set to the size of the request content before compression is done.

otel.otlp_exporter.request_duration

Set to the number of seconds, as a fraction, that the request took to complete. It is set with the following attributes:

status

Set to the HTTP status code of the response.

SEE ALSO

Compress::Zlib

Google::ProtocolBuffers::Dynamic

JSON::MaybeXS

OpenTelemetry::Exporter

OpenTelemetry::X::Unsupported

ACKNOWLEDGEMENTS

Special thanks to CV-Library Ltd. for their support in the development of this library.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by José Joaquín Atria.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.