Package 'otelsdk'

Description

This page is about collecting telemetry data from instrumented R packages. If you need help with instrumenting your R package, see Getting Started in the otel package.

Value

Not applicable.

Usage

• Instrument your R package or project using the otel package. Alternatively, use Zero Code Instrumentation to automatically instrument selected packages.

• Install the otelsdk package.

• Choose an exporter from the otelsdk package. The http exporter sends OpenTelemetry output through OTLP/HTTP.

• Set the OTEL_TRACES_EXPORTER environment variable to point to the exporter of your choice. E.g. for OTLP/HTTP set OTEL_TRACES_EXPORTER=http.

• If you are sending telemetry data through HTTP, then you typically need to configure the URL of your OpenTelemetry collector, and you possibly also need to supply a token in an HTTP header, possibly some resource attributes. Follow the instructions of the provider of your collector. They typically don't have instructions for R, but generic instructions about environment variables will work for the otelsdk R package. E.g. for Grafana you need something like

  OTEL_EXPORTER_OTLP_PROTOCOL="http"
  OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-eu-central-0.grafana.net/otlp" \
  OTEL_RESOURCE_ATTRIBUTES="service.name=<name-of-your-app>,service.namespace=<name-of-your-namespace>,deployment.environment=test"
  OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic%20<base64-encoded-token>"
  

  See more examples below.

• See all environment variables and the manual of your chosen provider for details on configuring otelsdk exporters.

• Start R and your app. Telemetry data will be exported to the chosen exporter.

Setup

Setup for remote collectors

There are a lot of services that offer an OpenTelemetry collector for tracers, logs and metrics, many of them supporting all three of them. There are also local apps that work as a collector. We tried otelsdk with the following ones:

Grafana

Follow the documentation. Create an API token. You'll need to use the Grafana instrance ID as your username, and the token as the password in HTTP Basic auth. E.g. in R do this to get the base64 encoded token. instance-id is a (currently seven digit) number and a string with a glc_ prefix.

openssl::base64_encode("<instance-id>:<api-token>")

Then use this encoded token to set the Authorization header:

OTEL_EXPORTER_OTLP_PROTOCOL="http"
OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-eu-central-0.grafana.net/otlp" \
OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic%20<base64-encoded-token>"
OTEL_RESOURCE_ATTRIBUTES="service.name=<name-of-your-app,service.namespace=<name-of-your-namespace>,deployment.environment=test"

Your endpoint URL is probably different, use the one that you see on your dashboard.

If you want to export logs and/or metrics, set these environment variables, respectively:

OTEL_LOGS_EXPORTER=http
OTEL_LOG_LEVEL=debug
OTEL_METRICS_EXPORTER=http

It also makes sense to set the desired log level.

Grafana suggests running an OpenTelemetry collector on premise instead of sending telemetry data to them directly. But nevertheless you can start out without running your own collector, they call this "quick start" mode.

Pydantic Logfire

Create a project and a write token. Note that the URLs you need to use are different if you are within the EU! You probably need to replace us with eu in the URL if you are in the EU. Set these environment variables:

OTEL_TRACES_EXPORTER=http
OTEL_EXPORTER_OTLP_ENDPOINT="https://logfire-us.pydantic.dev"
OTEL_EXPORTER_OTLP_HEADERS="Authorization=<your-write-token>"

For logs also set OTEL_LOGS_EXPORTER and the desired log level:

OTEL_LOGS_EXPORTER=http
OTEL_LOG_LEVEL=debug

For exporting metrics also set

OTEL_METRICS_EXPORTER=http

Setup for local collectors

otel-tui

otel-tui is a terminal app that supports traces, logs and metrics. It is great for development, as you can keep all your telemetry local while instrumenting your package or app. Follow the installation instructions and then run the app from a terminal:

otel-tui

It listens on the default port, so the setup is very simple, set these environment variables (or a subset if you don't want metrics or logs):

OTEL_TRACES_EXPORTER=http
OTEL_LOGS_EXPORTER=http
OTEL_LOG_LEVEL=debug
OTEL_METRICS_EXPORTER=http

otel-desktop-viewer

otel-desktop-viewer is similar to otel-tui, but has a web UI. Follow the installation instructions and start the app from a terminal:

otel-desktop-viewer

It should start a new windows or tab in your local web browser. Set the usual environment variable for your R app:

OTEL_TRACES_EXPORTER=http

Jaeger

If you have Docker, you can start a Jaeger container on the default port:

docker run --rm --name jaeger \
 -p 16686:16686 \
 -p 4317:4317 \
 -p 4318:4318 \
 -p 5778:5778 \
 -p 9411:9411 \
 jaegertracing/jaeger:2.4.0

Go to ⁠http://localhost:16686/⁠ to view the Jaeger UI.

SigNoz

To run SigNoz locally with Docker, clone the repository at https://github.com/SigNoz/signoz:

git clone --depth 1 https://github.com/SigNoz/signoz

and then run Docker Compose from the ⁠deploy/docker/⁠ subdirectory:

cd deploy/docker
docker compose up

Go to ⁠http://localhost:8080⁠ to see the SigNoz UI.

Examples

# See above

Description

See also the Environment Variables in the otel package, which is charge of selecting the exporters to use.

Value

Not applicable.

The OpenTelemetry Specification

Most of these environment variables are based on the OpenTelemetry Specification, version 1.55.0.

The environment variables with an 'OTEL_R_' prefix are not (yet) in the standard, and are specific for the otel and otelsdk R packages.

General SDK Configuration

• OTEL_SDK_DISABLED

  Set to a 'true' value to disable the SDK for all signals.

• OTEL_RESOURCE_ATTRIBUTES

  Key-value pairs to be used as resource attributes. See the Resource SDK for more details.

• OTEL_SERVICE_NAME

  Sets the value of the service.name resource attribute.

• OTEL_LOG_LEVEL

  Log level used by the SDK internal logger. In R it is also used for the default log level of the OpenTelemetry loggers.

Selecting Exporters

otel is responsible for selecting the providers to use for traces, logs and metrics. You can use the environment variables below to point the otel functions to the desired providers.

If none of these environment variables are set, then otel will not emit any telemetry data.

• OTEL_TRACES_EXPORTER

  The name of the selected tracer provider. See otel::get_default_tracer_provider() for the possible values.

• OTEL_R_TRACES_EXPORTER

  R specific version of OTEL_TRACES_EXPORTER.

• OTEL_LOGS_EXPORTER

  The name of the selected logger provider. See otel::get_default_logger_provider() for the possible values.

• OTEL_R_LOGS_EXPORTER

  R specific version of OTEL_LOGS_EXPORTER.

• OTEL_METRICS_EXPORTER

  The name of the selected meter provider. See otel::get_default_meter_provider() for the possible values.

• OTEL_R_METRICS_EXPORTER

  R specific version of OTEL_METRICS_EXPORTER.

Suppressing Instrumentation Scopes (R Packages)

otel has two environment variables to fine tune which instrumentation scopes (i.e. R packages, typically) emit telemetry data. By default, i.e. if neither of these are set, all packages emit telemetry data.

• OTEL_R_EMIT_SCOPES

  Set this environment variable to a comma separated string of instrumentation scope names or R package names to restrict telemetry to these packages only. The name of the instrumentation scope is the same as the name of the tracer, logger or meter, see otel::default_tracer_name().

  You can mix package names and instrumentation scope names and you can also use wildcards (globbing). For example the value

  OTEL_R_EMIT_SCOPES="org.r-lib.*,dplyr"

  selects all packages with an instrumentation scope that starts with org.r-lib. and also dplyr.

• OTEL_R_SUPPRESS_SCOPES

  Set this environment variable to a comma separated string of instrumentation scope names or R package names to suppress telemetry data from these packages. The name of the instrumentation scope is the same as the name of the tracer, logger or meter, see otel::default_tracer_name().

  You can mix package names and instrumentation scope names and you can also use wildcards (globbing). For example the value

  OTEL_R_SUPPRESS_SCOPES="org.r-lib.*,dplyr"

  excludes packages with an instrumentation scope that starts with org.r-lib. and also dplyr.

Zero Code Instrumentation

otel can instrument R packages for OpenTelemetry data collection without changing their source code. This relies on changing the code of the R functions manually using base::trace() and can be configured using environment variables.

• OTEL_R_INSTRUMENT_PKGS

  Set OTEL_R_INSTRUMENT_PKGS to a comma separated list of packages to instrument. The automatic instrumentation happens when the otel package is loaded, so in general it is best to set this environment variable before loading R.

• ⁠OTEL_R_INSTRUMENT_PKGS_<pkg>_INCLUDE⁠

  For an automatically instrumented package, set this environment variable to only instrument a subset of its functions. It is parsed as a comma separated string of function names, which may also include ⁠?⁠ and * wildcards (globbing).

• ⁠OTEL_R_INSTRUMENT_PKGS_<pkg>_EXCLUDE⁠

  For an automatically instrumented package, set this environment variable to exclude some functions from instrumentation. It has the same syntax as its ⁠*_INCLUDE⁠ pair. If both are set, then inclusion is applied and the exclusion.

Attribute Limits

• OTEL_ATTRIBUTE_COUNT_LIMIT

  Set this environment variable to limit the number of attributes for a single span, log record, metric measurement, etc. If unset, the default limit is 128 attributes. Note that only attributes specified with otel::as_attributes() are subject to this environment variable.

• OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT

  Set this environment variable to limit the length of vectors in attributes for a single span, log record, metric measurement, etc. If unset, there is no limit on the lengths of vectors in attributes. Note that only attributes specified with otel::as_attributes() are subject to this environment variable.

OTLP/HTTP Exporters

These environment variables are used by tracer_provider_http, meter_provider_http and logger_provider_http.

For every set of environment variables, the signal specific ones have priority over the generic one.

• OTEL_EXPORTER_OTLP_ENDPOINT | OTEL_EXPORTER_OTLP_TRACES_ENDPOINT | OTEL_EXPORTER_OTLP_METRICS_ENDPOINT | OTEL_EXPORTER_OTLP_LOGS_ENDPOINT

  OTLP URL to send telemetry data to. When the generic environment variable is used, the exporter appends the signal specific endpoint to it. The signal specific environment variables are used as is. More in the OpenTelemetry specification.

• OTEL_EXPORTER_OTLP_PROTOCOL | OTEL_EXPORTER_OTLP_TRACES_PROTOCOL | OTEL_EXPORTER_OTLP_METRICS_PROTOCOL | OTEL_EXPORTER_OTLP_LOGS_PROTOCOL

  The transport protocol. Possible values: http/json, http/protobuf.

• OTEL_R_EXPORTER_OTLP_JSON_BYTES_MAPPING | OTEL_R_EXPORTER_OTLP_TRACES_JSON_BYTES_MAPPING | OTEL_R_EXPORTER_OTLP_METRICS_JSON_BYTES_MAPPING | OTEL_R_EXPORTER_OTLP_LOGS_JSON_BYTES_MAPPING

  Encoding used for trace ids and spans id. Possible values: hexid, base64, hex.

• OTEL_R_EXPORTER_OTLP_USE_JSON_NAME | OTEL_R_EXPORTER_OTLP_TRACES_USE_JSON_NAME | OTEL_R_EXPORTER_OTLP_METRICS_USE_JSON_NAME | OTEL_R_EXPORTER_OTLP_LOGS_USE_JSON_NAME

  Whether to use json name of protobuf field to set the key of json. A boolean value (flag, true or false).

• OTEL_R_EXPORTER_OTLP_CONSOLE_DEBUG | OTEL_R_EXPORTER_OTLP_TRACES_CONSOLE_DEBUG | OTEL_R_EXPORTER_OTLP_METRICS_CONSOLE_DEBUG | OTEL_R_EXPORTER_OTLP_LOGS_CONSOLE_DEBUG

  Whether to print debug messages to the console. A boolean value (flag, true or false).

• OTEL_EXPORTER_OTLP_TIMEOUT | OTEL_EXPORTER_OTLP_TRACES_TIMEOUT | OTEL_EXPORTER_OTLP_METRICS_TIMEOUT | OTEL_EXPORTER_OTLP_LOGS_TIMEOUT

  HTTP timeout in milliseconds.

• OTEL_EXPORTER_OTLP_HEADERS | OTEL_EXPORTER_OTLP_TRACES_HEADERS | OTEL_EXPORTER_OTLP_METRICS_HEADERS | OTEL_EXPORTER_OTLP_LOGS_HEADERS

  Additional HTTP headers to send. E.g. Authorization is commonly used. It must be a comma separated list of headers, each in the header=value form.

• OTEL_R_EXPORTER_OTLP_SSL_INSECURE_SKIP_VERIFY | OTEL_R_EXPORTER_OTLP_TRACES_SSL_INSECURE_SKIP_VERIFY | OTEL_R_EXPORTER_OTLP_METRICS_SSL_INSECURE_SKIP_VERIFY | OTEL_R_EXPORTER_OTLP_LOGS_SSL_INSECURE_SKIP_VERIFY

  Whether to disable SSL. A boolean value (flag, true or false).

• OTEL_EXPORTER_OTLP_CERTIFICATE | OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE | OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE | OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE

  CA certificate, path to a file.

• OTEL_EXPORTER_OTLP_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE_STRING

  CA certificate, as a string.

• OTEL_EXPORTER_OTLP_CLIENT_KEY | OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY | OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY | OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY

  SSL client key, path to a file.

• OTEL_EXPORTER_OTLP_CLIENT_KEY_STRING | OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY_STRING | OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY_STRING | OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY_STRING

  SSL client key as a string.

• OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE | OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE | OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE | OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE

  SSL client certificate, path to a file.

• OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE_STRING | OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE_STRING

  SSL client certificate, as a string.

• OTEL_R_EXPORTER_OTLP_SSL_MIN_TLS | OTEL_R_EXPORTER_OTLP_TRACES_SSL_MIN_TLS | OTEL_R_EXPORTER_OTLP_METRICS_SSL_MIN_TLS | OTEL_R_EXPORTER_OTLP_LOGS_SSL_MIN_TLS

  Minimum TLS version.

• OTEL_R_EXPORTER_OTLP_SSL_MAX_TLS | OTEL_R_EXPORTER_OTLP_TRACES_SSL_MAX_TLS | OTEL_R_EXPORTER_OTLP_METRICS_SSL_MAX_TLS | OTEL_R_EXPORTER_OTLP_LOGS_SSL_MAX_TLS

  Maximum TLS version.

• OTEL_R_EXPORTER_OTLP_SSL_CIPHER | OTEL_R_EXPORTER_OTLP_TRACES_SSL_CIPHER | OTEL_R_EXPORTER_OTLP_METRICS_SSL_CIPHER | OTEL_R_EXPORTER_OTLP_LOGS_SSL_CIPHER

  TLS cipher.

• OTEL_R_EXPORTER_OTLP_SSL_CIPHER_SUITE | OTEL_R_EXPORTER_OTLP_TRACES_SSL_CIPHER_SUITE | OTEL_R_EXPORTER_OTLP_METRICS_SSL_CIPHER_SUITE | OTEL_R_EXPORTER_OTLP_LOGS_SSL_CIPHER_SUITE

  TLS cipher suite.

• OTEL_EXPORTER_OTLP_COMPRESSION | OTEL_EXPORTER_OTLP_TRACES_COMPRESSION | OTEL_EXPORTER_OTLP_METRICS_COMPRESSION | OTEL_EXPORTER_OTLP_LOGS_COMPRESSION

  Compression to use. none, gzip.

• OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_ATTEMPTS | OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_MAX_ATTEMPTS | OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_MAX_ATTEMPTS | OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_MAX_ATTEMPTS

  The maximum number of call attempts, including the original attempt.

• OTEL_R_EXPORTER_OTLP_RETRY_POLICY_INITIAL_BACKOFF | OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_INITIAL_BACKOFF | OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_INITIAL_BACKOFF | OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_INITIAL_BACKOFF

  The maximum initial back-off delay between retry attempts. The actual backoff delay is uniform random between zero and this. It is in milliseconds.

• OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_BACKOFF | OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_MAX_BACKOFF | OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_MAX_BACKOFF | OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_MAX_BACKOFF

  The maximum backoff places an upper limit on exponential backoff growth.

• OTEL_R_EXPORTER_OTLP_RETRY_POLICY_BACKOFF_MULTIPLIER | OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_BACKOFF_MULTIPLIER | OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_BACKOFF_MULTIPLIER | OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_BACKOFF_MULTIPLIER

  The backoff will be multiplied by this value after each retry attempt.

OTLP/FILE Exporters

These environment variables are used by tracer_provider_file, meter_provider_file and logger_provider_file.

For every set of environment variables, the signal specific ones have priority over the generic one.

• OTEL_EXPORTER_OTLP_FILE | OTEL_EXPORTER_OTLP_TRACES_FILE | OTEL_EXPORTER_OTLP_METRICS_FILE | OTEL_EXPORTER_OTLP_LOGS_FILE

  Output file pattern. May contain placeholders, see the manual pages of the providers, linked at the beginning of the section.

• OTEL_EXPORTER_OTLP_FILE_ALIAS | OTEL_EXPORTER_OTLP_TRACES_FILE_ALIAS | OTEL_EXPORTER_OTLP_METRICS_FILE_ALIAS | OTEL_EXPORTER_OTLP_LOGS_FILE_ALIAS

  The file which always point to the latest file. May contain placeholders, see the manual pages of the providers, linked at the beginning of the section.

• OTEL_EXPORTER_OTLP_FILE_FLUSH_INTERVAL | OTEL_EXPORTER_OTLP_TRACES_FILE_FLUSH_INTERVAL | OTEL_EXPORTER_OTLP_METRICS_FILE_FLUSH_INTERVAL | OTEL_EXPORTER_OTLP_LOGS_FILE_FLUSH_INTERVAL

  Interval to force flush output. A time interval specification, see Time Interval Options.

• OTEL_EXPORTER_OTLP_FILE_FLUSH_COUNT | OTEL_EXPORTER_OTLP_TRACES_FILE_FILE_SIZE | OTEL_EXPORTER_OTLP_METRICS_FILE_FILE_SIZE | OTEL_EXPORTER_OTLP_LOGS_FILE_FILE_SIZE

  Force flush output after every flush_count records.

• OTEL_EXPORTER_OTLP_FILE_FILE_SIZE | OTEL_EXPORTER_OTLP_TRACES_FILE_FILE_SIZE | OTEL_EXPORTER_OTLP_METRICS_FILE_FILE_SIZE | OTEL_EXPORTER_OTLP_LOGS_FILE_FILE_SIZE

  File size to rotate output files. A file size specification, see File Size Options.

• OTEL_EXPORTER_OTLP_FILE_ROTATE_SIZE | OTEL_EXPORTER_OTLP_TRACES_FILE_ROTATE_SIZE | OTEL_EXPORTER_OTLP_METRICS_FILE_ROTATE_SIZE | OTEL_EXPORTER_OTLP_LOGS_FILE_ROTATE_SIZE

  How many rotated output files to keep.

Batch Processor

These environment variables are used by tracer_provider_http, and logger_provider_http.

• OTEL_BSP_SCHEDULE_DELAY

  The maximum buffer/queue size. After the size is reached, spans are dropped. Must be positive.

• OTEL_BSP_MAX_QUEUE_SIZE

  The maximum batch size of every export. It must be smaller or equal to max_queue_size. Must be positive.

• OTEL_BSP_MAX_EXPORT_BATCH_SIZE

  The time interval between two consecutive exports, in milliseconds.

Metric Reader

These environment variables are used by meter_provider_http, meter_provider_stdstream meter_provider_memory and meter_provider_file.

• OTEL_METRIC_EXPORT_INTERVAL

  The time interval between the start of two export attempts, in milliseconds.

• OTEL_METRIC_EXPORT_TIMEOUT

  Maximum allowed time to export data, in milliseconds.

Metric Exporters

These environment variables are used by meter_provider_http and meter_provider_memory.

• OTEL_R_EXPORTER_OTLP_AGGREGATION_TEMPORALITY

  Aggregation temporality. Possible values: unspecified, delta, cumulative, lowmemory. See the OpenTelemetry data model.

Standard Stream Exporters

These environment variables are used by tracer_provider_stdstream, meter_provider_stdstream and logger_provider_stdstream.

The signal specific environment variables have priority over the generic one.

• OTEL_R_EXPORTER_STDSTREAM_OUTPUT | OTEL_R_EXPORTER_STDSTREAM_TRACES_OUTPUT | OTEL_R_EXPORTER_STDSTREAM_METRICS_OUTPUT | OTEL_R_EXPORTER_STDSTREAM_LOGS_OUTPUT

  Where to write the output. Can be

  • stdout: write output to the standard output,

  • stderr: write output to the standard error,

  • another string: write output to a file. (To write output to a file named stdout or ⁠"stderr⁠, use a ⁠./⁠ prefix.)

In-Memory Exporters

These environment variables are used by tracer_provider_memory and meter_provider_memory.

The signal specific environment variables have priority over the generic one.

• OTEL_R_EXPORTER_MEMORY_BUFFER_SIZE | OTEL_R_EXPORTER_MEMORY_TRACES_BUFFER_SIZE | OTEL_R_EXPORTER_MEMORY_METRICS_BUFFER_SIZE | OTEL_R_EXPORTER_MEMORY_BUFFER_SIZE

  Buffer size, this is the maximum number of spans or metrics measurements that the provider can record.

Support Matrix of all OpenTelemetry Environment Variables for R

(1) In otel::as_attributes().

See Also

Environment Variables in otel

Examples

# To start an R session using the OTLP exporter:
# OTEL_TRACES_EXPORTER=http R -q -f script.R

Description

otel and otelsdk accept file size options in the following format:

• As a positive numeric scalar, interpreted as number of bytes.

• A string scalar with a positive number and a unit suffix. Possible units: B, KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB. Units are case insensitive.

Value

Not applicable.

Examples

# Maximum output file size is 128 MiB:
# OTEL_EXPORTER_OTLP_FILE_FILE_SIZE=128MiB

Description

This is the OTLP file exporter. It writes logs to a JSONL file, each log is a line in the file, a valid JSON value. The line separator is ⁠\n⁠. The preferred file extension is jsonl.

Select this tracer provider with OTEL_LOGS_EXPORTER=otlp/file.

Value

logger_provider_file$new() returns an otel::otel_logger_provider object.

logger_provider_file$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_LOGS_EXPORTER=otlp/file

From R:

logger_provider_file$new(opts = NULL)
logger_provider_file$options()

Arguments

• opts: Named list of options. See below.

Options

File exporter options

• file_pattern: Output file pattern. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE environment variable, or

  • the default is: ⁠logs-%N.jsonl⁠.

  May contain placeholders, see below.

• alias_pattern: The file which always point to the latest file. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE_ALIAS environment variable, or

  • ⁠OTEL_EXPORTER_OTLP_FILE_ALIAS environment variable⁠, or

  • the default is: logs-latest.jsonl.

  May contain placeholders, see below.

• flush_interval: Interval to force flush output. A time interval specification, see Time Interval Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE_FLUSH_INTERVAL environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_INTERVAL environment variable, or

  • the default is ⁠30s⁠, thirty seconds.

• flush_count: Force flush output after every flush_count records. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE_FLUSH_COUNT environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_COUNT environment variable, or

  • the default is 256.

• file_size: File size to rotate output files. A file size specification, see File Size Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE_FILE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FILE_SIZE environment variable, or

  • the default is ⁠20MB⁠.

• rotate_size: How many rotated output files to keep. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_LOGS_FILE_ROTATE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_ROTATE_SIZE environment variable, or

  • the default is 10.

Special placeholders are available for file_pattern and alias_pattern:

• ⁠%Y⁠: Writes year as a 4 digit decimal number.

• ⁠%y⁠: Writes last 2 digits of year as a decimal number (range ⁠[00,99]⁠).

• ⁠%m⁠: Writes month as a decimal number (range ⁠[01,12]⁠).

• ⁠%j⁠: Writes day of the year as a decimal number (range ⁠[001,366]⁠).

• ⁠%d⁠: Writes day of the month as a decimal number (range ⁠[01,31]⁠).

• ⁠%w⁠: Writes weekday as a decimal number, where Sunday is 0 (range ⁠[0-6]⁠).

• ⁠%H⁠: Writes hour as a decimal number, 24 hour clock (range ⁠[00-23]⁠).

• ⁠%I⁠: Writes hour as a decimal number, 12 hour clock (range ⁠[01,12]⁠).

• ⁠%M⁠: Writes minute as a decimal number (range ⁠[00,59]⁠).

• ⁠%S⁠: Writes second as a decimal number (range ⁠[00,60]⁠).

• ⁠%F⁠: Equivalent to ⁠%Y-%m-%d⁠ (the ISO 8601 date format).

• ⁠%T⁠: Equivalent to ⁠%H:%M:%S⁠ (the ISO 8601 time format).

• ⁠%R⁠: Equivalent to ⁠%H:%M⁠.

• ⁠%N⁠: Rotate index, start from 0.

• ⁠%n⁠: Rotate index, start from 1.

Examples

logger_provider_file$options()

Description

This is the OTLP HTTP exporter.

Value

logger_provider_http$new() returns an otel::otel_logger_provider object.

logger_provider_http$options() returns a named list, the current values for all options.

Usage

Externally:

OTEL_LOGS_EXPORTER=otlp

From R:

logger_provider_http$new(opts = NULL)
logger_provider_http$options()

Arguments

• opts: Named list of options. See below.

Options

HTTP exporter options

• url: OTLP URL to send telemetry data to. Value is set from

  • the opts argument, needs to point to the logs endpoint, or

  • OTEL_EXPORTER_OTLP_LOGS_ENDPOINT environment variable, needs to point to the logs endpoint, or

  • OTEL_EXPORTER_OTLP_ENDPOINT environment variable + ⁠/v1/logs⁠, or

  • the default is ⁠http://localhost:4318/v1/logs⁠.

• content_type: data format used, JSON or binary. Possible values: "http/json", "http/protobuf". Value if set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_PROTOCOL environment variable, or

  • the OTEL_EXPORTER_OTLP_PROTOCOL environment variable, or

  • the default is "http/protobuf".

• json_bytes_mapping: encoding used for trace id and span id. Possible values: "hexid", "base64", "hex". Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_JSON_BYTES_MAPPING environment variable, or

  • the OTEL_R_EXPORTER_OTLP_JSON_BYTES_MAPPING environment variable, or

  • the default is "hexid".

• use_json_name: whether to use json name of protobuf field to set the key of json. A flag. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_USE_JSON_NAME environment variable, or

  • the OTEL_R_EXPORTER_OTLP_USE_JSON_NAME environment variable, or

  • the default is FALSE.

• console_debug: whether to print debug messages to the console. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_CONSOLE_DEBUG environment variable, or

  • the OTEL_R_EXPORTER_OTLP_CONSOLE_DEBUG environment variable, or

  • the default is FALSE.

• timeout: HTTP timeout in milliseconds. Value is set from

  • the opts argument, or

  • the ⁠OTEL_EXPORTER_OTLP_LOGS_TIMEOUT}⁠ environment variable, or

  • the OTEL_EXPORTER_OTLP_TIMEOUT environment variable, or

  • the default is 10000.

• http_headers: additional HTTP headers to send, e.g. Authorization is commonly used. A named character vector without NA values. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_HEADERS environment variable, or

  • the OTEL_EXPORTER_OTLP_HEADERS environment variable, or

  • the default is an empty named character vector. When specified in environment variables, it must be a comma separated list of headers, each in the header=value form.

• ssl_insecure_skip_verify: whether to disable SSL. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the default is FALSE.

• ssl_ca_cert_path: CA certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE environment variable, or

  • the default is “.

• ssl_ca_cert_string: CA certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_client_key_path: SSL client key, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY environment variable, or

  • the default is “.

• ssl_client_key_string: SSL client key as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY_STRING environment variable, or

  • the default is “.

• ssl_client_cert_path: SSL client certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE environment variable, or

  • the default is “.

• ssl_client_cert_string: SSL client certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_min_tls: minimum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_SSL_MIN_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MIN_TLS environment variable, or

  • the default is “.

• ssl_max_tls: maximum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_SSL_MAX_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MAX_TLS environment variable, or

  • the default is “.

• ssl_cipher: TLS cipher. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_SSL_CIPHER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER environment variable, or

  • the default is “.

• ssl_cipher_suite: TLS cipher suite. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_SSL_CIPHER_SUITE environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER_SUITE environment variable, or

  • the default is “.

• compression: compression to use. Possible values are "none", "gzip". Value is the set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_LOGS_COMPRESSION environment variable, or

  • the OTEL_EXPORTER_OTLP_COMPRESSION environment variable, or

  • the default is none.

• retry_policy_max_attempts: the maximum number of call attempts, including the original attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the default is 5.

• retry_policy_initial_backoff: the maximum initial back-off delay between retry attempts. The actual backoff delay is uniform random between zero and this. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the default is 1000.

• retry_policy_max_backoff: the maximum backoff places an upper limit on exponential backoff growth. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the default is 5000.

• retry_policy_backoff_multiplier: the backoff will be multiplied by this value after each retry attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_LOGS_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the default is 1.5.

Batch processor options

• max_queue_size: The maximum buffer/queue size. After the size is reached, spans are dropped. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_BSP_MAX_QUEUE_SIZE environment variable, or

  • the default is 2048.

• max_export_batch_size: the maximum batch size of every export. It must be smaller or equal to max_queue_size. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_BSP_MAX_EXPORT_BATCH_SIZE environment variable, or

  • the default is 512.

• schedule_delay: the time interval between two consecutive exports, in milliseconds. Value is set from

  • the opts argument' or

  • the OTEL_BSP_SCHEDULE_DELAY environment variable, or

  • the default is 5000.

Examples

logger_provider_http$options()

Description

Writes logs to the standard output or error, or to a file. Useful for debugging.

Value

logger_provider_stdstream$new() returns an otel::otel_logger_provider object.

logger_provider_stdstream$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_LOGS_EXPORTER=console
OTEL_LOGS_EXPORTER=stderr

From R:

logger_provider_stdstream$new(opts = NULL)
logger_provider_stdstream$options()

Arguments

opts: Named list of options. See below.

Options

Standard stream exporter options

• output: where to write the output. Can be

  • "stdout": write output to the standard output,

  • "stderr": write output to the standard error,

  • another string: write output to a file. (To write output to a file named "stdout" or "stderr", use a ⁠./⁠ prefix.)

  Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_STDSTREAM_LOGS_OUTPUT environment variable, or

  • the OTEL_R_EXPORTER_STDSTREAM_OUTPUT environment variable, or

  • the default is "stdout".

Examples

logger_provider_stdstream$options()

Description

This is the OTLP file exporter. It writes measurements to a JSONL file, each measurement is a line in the file, a valid JSON value. The line separator is ⁠\n⁠. The preferred file extension is jsonl.

Select this tracer provider with OTEL_METRICS_EXPORTER=otlp/file.

Value

meter_provider_file$new() returns an otel::otel_meter_provider object.

meter_provider_file$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_METRICS_EXPORTER=otlp/file

From R:

meter_provider_file$new(opts = NULL)
meter_provider_file$options()

Arguments

• opts: Named list of options. See below.

Options

File exporter options

• file_pattern: Output file pattern. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE environment variable, or

  • the default is: ⁠metrics-%N.jsonl⁠.

  May contain placeholders, see below.

• alias_pattern: The file which always point to the latest file. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE_ALIAS environment variable, or

  • ⁠OTEL_EXPORTER_OTLP_FILE_ALIAS environment variable⁠, or

  • the default is: metrics-latest.jsonl.

  May contain placeholders, see below.

• flush_interval: Interval to force flush output. A time interval specification, see Time Interval Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE_FLUSH_INTERVAL environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_INTERVAL environment variable, or

  • the default is ⁠30s⁠, thirty seconds.

• flush_count: Force flush output after every flush_count records. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE_FLUSH_COUNT environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_COUNT environment variable, or

  • the default is 256.

• file_size: File size to rotate output files. A file size specification, see File Size Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE_FILE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FILE_SIZE environment variable, or

  • the default is ⁠20MB⁠.

• rotate_size: How many rotated output files to keep. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_METRICS_FILE_ROTATE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_ROTATE_SIZE environment variable, or

  • the default is 10.

Special placeholders are available for file_pattern and alias_pattern:

• ⁠%Y⁠: Writes year as a 4 digit decimal number.

• ⁠%y⁠: Writes last 2 digits of year as a decimal number (range ⁠[00,99]⁠).

• ⁠%m⁠: Writes month as a decimal number (range ⁠[01,12]⁠).

• ⁠%j⁠: Writes day of the year as a decimal number (range ⁠[001,366]⁠).

• ⁠%d⁠: Writes day of the month as a decimal number (range ⁠[01,31]⁠).

• ⁠%w⁠: Writes weekday as a decimal number, where Sunday is 0 (range ⁠[0-6]⁠).

• ⁠%H⁠: Writes hour as a decimal number, 24 hour clock (range ⁠[00-23]⁠).

• ⁠%I⁠: Writes hour as a decimal number, 12 hour clock (range ⁠[01,12]⁠).

• ⁠%M⁠: Writes minute as a decimal number (range ⁠[00,59]⁠).

• ⁠%S⁠: Writes second as a decimal number (range ⁠[00,60]⁠).

• ⁠%F⁠: Equivalent to ⁠%Y-%m-%d⁠ (the ISO 8601 date format).

• ⁠%T⁠: Equivalent to ⁠%H:%M:%S⁠ (the ISO 8601 time format).

• ⁠%R⁠: Equivalent to ⁠%H:%M⁠.

• ⁠%N⁠: Rotate index, start from 0.

• ⁠%n⁠: Rotate index, start from 1.

Metric reader options

• export_interval: the time interval between the start of two export attempts, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_INTERVAL environment variable, or

  • the default is 60000.

• export_timeout: Maximum allowed time to export data, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_TIMEOUT environment variable, or

  • the default is 30000.

Examples

meter_provider_file$options()

Description

This is the OTLP HTTP exporter.

Select this tracer provider with OTEL_METRICS_EXPORTER=otlp.

Value

meter_provider_http$new() returns an otel::otel_meter_provider object.

meter_provider_http$options() returns a named list, the current values for all options.

Usage

Externally:

OTEL_METRICS_EXPORTER=otlp

From R:

meter_provider_http$new(opts = NULL)
meter_provider_http$options()

Arguments

• opts: Named list of options. See below.

Options

HTTP exporter options

• url: OTLP URL to send telemetry data to. Value is set from

  • the opts argument, needs to point to the metrics endpoint, or

  • OTEL_EXPORTER_OTLP_METRICS_ENDPOINT environment variable, needs to point to the metrics endpoint, or

  • OTEL_EXPORTER_OTLP_ENDPOINT environment variable + ⁠/v1/metrics⁠, or

  • the default is ⁠http://localhost:4318/v1/metrics⁠.

• content_type: data format used, JSON or binary. Possible values: "http/json", "http/protobuf". Value if set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_PROTOCOL environment variable, or

  • the OTEL_EXPORTER_OTLP_PROTOCOL environment variable, or

  • the default is "http/protobuf".

• json_bytes_mapping: encoding used for trace id and span id. Possible values: "hexid", "base64", "hex". Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_JSON_BYTES_MAPPING environment variable, or

  • the OTEL_R_EXPORTER_OTLP_JSON_BYTES_MAPPING environment variable, or

  • the default is "hexid".

• use_json_name: whether to use json name of protobuf field to set the key of json. A flag. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_USE_JSON_NAME environment variable, or

  • the OTEL_R_EXPORTER_OTLP_USE_JSON_NAME environment variable, or

  • the default is FALSE.

• console_debug: whether to print debug messages to the console. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_CONSOLE_DEBUG environment variable, or

  • the OTEL_R_EXPORTER_OTLP_CONSOLE_DEBUG environment variable, or

  • the default is FALSE.

• timeout: HTTP timeout in milliseconds. Value is set from

  • the opts argument, or

  • the ⁠OTEL_EXPORTER_OTLP_METRICS_TIMEOUT}⁠ environment variable, or

  • the OTEL_EXPORTER_OTLP_TIMEOUT environment variable, or

  • the default is 10000.

• http_headers: additional HTTP headers to send, e.g. Authorization is commonly used. A named character vector without NA values. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_HEADERS environment variable, or

  • the OTEL_EXPORTER_OTLP_HEADERS environment variable, or

  • the default is an empty named character vector. When specified in environment variables, it must be a comma separated list of headers, each in the header=value form.

• ssl_insecure_skip_verify: whether to disable SSL. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the default is FALSE.

• ssl_ca_cert_path: CA certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE environment variable, or

  • the default is “.

• ssl_ca_cert_string: CA certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_client_key_path: SSL client key, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY environment variable, or

  • the default is “.

• ssl_client_key_string: SSL client key as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY_STRING environment variable, or

  • the default is “.

• ssl_client_cert_path: SSL client certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE environment variable, or

  • the default is “.

• ssl_client_cert_string: SSL client certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_min_tls: minimum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_SSL_MIN_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MIN_TLS environment variable, or

  • the default is “.

• ssl_max_tls: maximum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_SSL_MAX_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MAX_TLS environment variable, or

  • the default is “.

• ssl_cipher: TLS cipher. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_SSL_CIPHER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER environment variable, or

  • the default is “.

• ssl_cipher_suite: TLS cipher suite. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_SSL_CIPHER_SUITE environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER_SUITE environment variable, or

  • the default is “.

• compression: compression to use. Possible values are "none", "gzip". Value is the set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_METRICS_COMPRESSION environment variable, or

  • the OTEL_EXPORTER_OTLP_COMPRESSION environment variable, or

  • the default is none.

• retry_policy_max_attempts: the maximum number of call attempts, including the original attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the default is 5.

• retry_policy_initial_backoff: the maximum initial back-off delay between retry attempts. The actual backoff delay is uniform random between zero and this. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the default is 1000.

• retry_policy_max_backoff: the maximum backoff places an upper limit on exponential backoff growth. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the default is 5000.

• retry_policy_backoff_multiplier: the backoff will be multiplied by this value after each retry attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_METRICS_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the default is 1.5.

Metric reader options

• export_interval: the time interval between the start of two export attempts, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_INTERVAL environment variable, or

  • the default is 60000.

• export_timeout: Maximum allowed time to export data, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_TIMEOUT environment variable, or

  • the default is 30000.

Metric exporter options

• aggregation_temporality: possible values: "unspecified", "delta", "cumulative", "lowmemory". See the OpenTelemetry data model. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_AGGREGATION_TEMPORALITY environment variable, or

  • the default is "cumulative".

Examples

meter_provider_http$options()

Description

Collects metrics measurements in memory. This is useful for testing your instrumented R package or application.

with_otel_record() uses this meter provider. Use with_otel_record() in your tests to record telemetry and check that it is correct.

Value

meter_provider_memory$new() returns an otel::otel_meter_provider object. mp$get_metrics() returns a named list of recorded metrics.

meter_provider_memory$options() returns a named list, the current values for all options.

Usage

mp <- meter_provider_memory$new(opts = NULL)
mp$get_metrics()
meter_provider_memory$options()

mp$get_metrics() erases the internal buffer of the meter provider.

Arguments

• opts: Named list of options. See below.

Options

Memory exporter options

• buffer_size: buffer size, this is the maximum number of spans or metrics measurements that the provider can record. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_MEMORY_METRICS_BUFFER_SIZE environment variable, or

  • the OTEL_R_EXPORTER_MEMORY_BUFFER_SIZE environment variable, or

  • the default is 100.

Metric reader options

• export_interval: the time interval between the start of two export attempts, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_INTERVAL environment variable, or

  • the default is 60000.

• export_timeout: Maximum allowed time to export data, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_TIMEOUT environment variable, or

  • the default is 30000.

Metric exporter options

• aggregation_temporality: possible values: "unspecified", "delta", "cumulative", "lowmemory". See the OpenTelemetry data model. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_AGGREGATION_TEMPORALITY environment variable, or

  • the default is "cumulative".

Examples

meter_provider_memory$options()

Description

Writes metrics measurements to the standard output or error, or to a file. Useful for debugging.

Value

meter_provider_stdstream$new() returns an otel::otel_meter_provider object.

meter_provider_stdstream$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_METRICS_EXPORTER=console
OTEL_METRICS_EXPORTER=stderr

From R:

meter_provider_stdstream$new(opts = NULL)
meter_provider_stdstream$options()

Arguments

opts: Named list of options. See below.

Options

Standard stream exporter options

• output: where to write the output. Can be

  • "stdout": write output to the standard output,

  • "stderr": write output to the standard error,

  • another string: write output to a file. (To write output to a file named "stdout" or "stderr", use a ⁠./⁠ prefix.)

  Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_STDSTREAM_METRICS_OUTPUT environment variable, or

  • the OTEL_R_EXPORTER_STDSTREAM_OUTPUT environment variable, or

  • the default is "stdout".

Metric reader options

• export_interval: the time interval between the start of two export attempts, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_INTERVAL environment variable, or

  • the default is 60000.

• export_timeout: Maximum allowed time to export data, in milliseconds. Value is set from

  • the opts argument, or

  • the OTEL_METRIC_EXPORT_TIMEOUT environment variable, or

  • the default is 30000.

Examples

meter_provider_stdstream$options()

Description

otel and otelsdk accept time interval options in the following format:

• A base::difftime object.

• A positive numeric scalar, interpreted as number of milliseconds. It may be fractional.

• A string scalar with a positive number and a time unit suffix. Possible time units: us (microseconds), ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).

When the time interval is specified in an environment variable, it may be:

• A positive number, interpreted as number of milliseconds. It may be fractional.

• A positive number with a time unit suffix. Possible time units: us (microseconds), ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).

Value

Not applicable.

Examples

# Write pending telemetry data to the output file every 5 seconds:
# OTEL_EXPORTER_OTLP_FILE_FLUSH_INTERVAL=5s

Description

This is the OTLP file exporter. It writes spans to a JSONL file, each span is a line in the file, a valid JSON value. The line separator is ⁠\n⁠. The preferred file extension is jsonl.

Select this tracer provider with OTEL_TRACES_EXPORTER=otlp/file.

Value

tracer_provider_file$new() returns an otel::otel_tracer_provider object.

tracer_provider_file$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_TRACES_EXPORTER=otlp/file

From R:

tracer_provider_file$new(opts = NULL)
tracer_provider_file$options()

Arguments

• opts: Named list of options. See below.

Options

File exporter options

• file_pattern: Output file pattern. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE environment variable, or

  • the default is: ⁠trace-%N.jsonl⁠.

  May contain placeholders, see below.

• alias_pattern: The file which always point to the latest file. Value is set from:

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE_ALIAS environment variable, or

  • ⁠OTEL_EXPORTER_OTLP_FILE_ALIAS environment variable⁠, or

  • the default is: trace-latest.jsonl.

  May contain placeholders, see below.

• flush_interval: Interval to force flush output. A time interval specification, see Time Interval Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE_FLUSH_INTERVAL environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_INTERVAL environment variable, or

  • the default is ⁠30s⁠, thirty seconds.

• flush_count: Force flush output after every flush_count records. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE_FLUSH_COUNT environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FLUSH_COUNT environment variable, or

  • the default is 256.

• file_size: File size to rotate output files. A file size specification, see File Size Options. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE_FILE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_FILE_SIZE environment variable, or

  • the default is ⁠20MB⁠.

• rotate_size: How many rotated output files to keep. Value is set from

  • opts argument, or

  • OTEL_EXPORTER_OTLP_TRACES_FILE_ROTATE_SIZE environment variable, or

  • OTEL_EXPORTER_OTLP_FILE_ROTATE_SIZE environment variable, or

  • the default is 10.

Special placeholders are available for file_pattern and alias_pattern:

• ⁠%Y⁠: Writes year as a 4 digit decimal number.

• ⁠%y⁠: Writes last 2 digits of year as a decimal number (range ⁠[00,99]⁠).

• ⁠%m⁠: Writes month as a decimal number (range ⁠[01,12]⁠).

• ⁠%j⁠: Writes day of the year as a decimal number (range ⁠[001,366]⁠).

• ⁠%d⁠: Writes day of the month as a decimal number (range ⁠[01,31]⁠).

• ⁠%w⁠: Writes weekday as a decimal number, where Sunday is 0 (range ⁠[0-6]⁠).

• ⁠%H⁠: Writes hour as a decimal number, 24 hour clock (range ⁠[00-23]⁠).

• ⁠%I⁠: Writes hour as a decimal number, 12 hour clock (range ⁠[01,12]⁠).

• ⁠%M⁠: Writes minute as a decimal number (range ⁠[00,59]⁠).

• ⁠%S⁠: Writes second as a decimal number (range ⁠[00,60]⁠).

• ⁠%F⁠: Equivalent to ⁠%Y-%m-%d⁠ (the ISO 8601 date format).

• ⁠%T⁠: Equivalent to ⁠%H:%M:%S⁠ (the ISO 8601 time format).

• ⁠%R⁠: Equivalent to ⁠%H:%M⁠.

• ⁠%N⁠: Rotate index, start from 0.

• ⁠%n⁠: Rotate index, start from 1.

Examples

tracer_provider_file$options()

Description

This is the OTLP HTTP exporter.

Select this tracer provider with OTEL_TRACES_EXPORTER=otlp.

Value

tracer_provider_http$new() returns an otel::otel_tracer_provider object.

tracer_provider_http$options() returns a named list, the current values for all options.

Usage

Externally:

OTEL_TRACES_EXPORTER=otlp

From R:

tracer_provider_http$new(opts = NULL)
tracer_provider_http$options()

Arguments

• opts: Named list of options. See below.

Options

HTTP exporter options

• url: OTLP URL to send telemetry data to. Value is set from

  • the opts argument, needs to point to the traces endpoint, or

  • OTEL_EXPORTER_OTLP_TRACES_ENDPOINT environment variable, needs to point to the traces endpoint, or

  • OTEL_EXPORTER_OTLP_ENDPOINT environment variable + ⁠/v1/traces⁠, or

  • the default is ⁠http://localhost:4318/v1/traces⁠.

• content_type: data format used, JSON or binary. Possible values: "http/json", "http/protobuf". Value if set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_PROTOCOL environment variable, or

  • the OTEL_EXPORTER_OTLP_PROTOCOL environment variable, or

  • the default is "http/protobuf".

• json_bytes_mapping: encoding used for trace id and span id. Possible values: "hexid", "base64", "hex". Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_JSON_BYTES_MAPPING environment variable, or

  • the OTEL_R_EXPORTER_OTLP_JSON_BYTES_MAPPING environment variable, or

  • the default is "hexid".

• use_json_name: whether to use json name of protobuf field to set the key of json. A flag. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_USE_JSON_NAME environment variable, or

  • the OTEL_R_EXPORTER_OTLP_USE_JSON_NAME environment variable, or

  • the default is FALSE.

• console_debug: whether to print debug messages to the console. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_CONSOLE_DEBUG environment variable, or

  • the OTEL_R_EXPORTER_OTLP_CONSOLE_DEBUG environment variable, or

  • the default is FALSE.

• timeout: HTTP timeout in milliseconds. Value is set from

  • the opts argument, or

  • the ⁠OTEL_EXPORTER_OTLP_TRACES_TIMEOUT}⁠ environment variable, or

  • the OTEL_EXPORTER_OTLP_TIMEOUT environment variable, or

  • the default is 10000.

• http_headers: additional HTTP headers to send, e.g. Authorization is commonly used. A named character vector without NA values. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_HEADERS environment variable, or

  • the OTEL_EXPORTER_OTLP_HEADERS environment variable, or

  • the default is an empty named character vector. When specified in environment variables, it must be a comma separated list of headers, each in the header=value form.

• ssl_insecure_skip_verify: whether to disable SSL. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_INSECURE_SKIP_VERIFY environment variable, or

  • the default is FALSE.

• ssl_ca_cert_path: CA certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE environment variable, or

  • the default is “.

• ssl_ca_cert_string: CA certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_client_key_path: SSL client key, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY environment variable, or

  • the default is “.

• ssl_client_key_string: SSL client key as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_KEY_STRING environment variable, or

  • the default is “.

• ssl_client_cert_path: SSL client certificate, path to a file. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE environment variable, or

  • the default is “.

• ssl_client_cert_string: SSL client certificate, as a string. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE_STRING environment variable, or

  • the OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE_STRING environment variable, or

  • the default is “.

• ssl_min_tls: minimum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_SSL_MIN_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MIN_TLS environment variable, or

  • the default is “.

• ssl_max_tls: maximum TLS version. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_SSL_MAX_TLS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_MAX_TLS environment variable, or

  • the default is “.

• ssl_cipher: TLS cipher. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_SSL_CIPHER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER environment variable, or

  • the default is “.

• ssl_cipher_suite: TLS cipher suite. Empty string uses the system default. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_SSL_CIPHER_SUITE environment variable, or

  • the OTEL_R_EXPORTER_OTLP_SSL_CIPHER_SUITE environment variable, or

  • the default is “.

• compression: compression to use. Possible values are "none", "gzip". Value is the set from

  • the opts argument, or

  • the OTEL_EXPORTER_OTLP_TRACES_COMPRESSION environment variable, or

  • the OTEL_EXPORTER_OTLP_COMPRESSION environment variable, or

  • the default is none.

• retry_policy_max_attempts: the maximum number of call attempts, including the original attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_ATTEMPTS environment variable, or

  • the default is 5.

• retry_policy_initial_backoff: the maximum initial back-off delay between retry attempts. The actual backoff delay is uniform random between zero and this. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_INITIAL_BACKOFF environment variable, or

  • the default is 1000.

• retry_policy_max_backoff: the maximum backoff places an upper limit on exponential backoff growth. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_MAX_BACKOFF environment variable, or

  • the default is 5000.

• retry_policy_backoff_multiplier: the backoff will be multiplied by this value after each retry attempt. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_OTLP_TRACES_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the OTEL_R_EXPORTER_OTLP_RETRY_POLICY_BACKOFF_MULTIPLIER environment variable, or

  • the default is 1.5.

Batch processor options

• max_queue_size: The maximum buffer/queue size. After the size is reached, spans are dropped. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_BSP_MAX_QUEUE_SIZE environment variable, or

  • the default is 2048.

• max_export_batch_size: the maximum batch size of every export. It must be smaller or equal to max_queue_size. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_BSP_MAX_EXPORT_BATCH_SIZE environment variable, or

  • the default is 512.

• schedule_delay: the time interval between two consecutive exports, in milliseconds. Value is set from

  • the opts argument' or

  • the OTEL_BSP_SCHEDULE_DELAY environment variable, or

  • the default is 5000.

Examples

tracer_provider_http$options()

Description

Collects spans in memory. This is useful for testing your instrumented R package or application.

with_otel_record() uses this tracer provider. Use with_otel_record() in your tests to record telemetry and check that it is correct.

Value

tracer_provider_memory$new() returns an otel::otel_tracer_provider object. tp$get_spans() returns a named list of recorded spans, with the span names as names.

tracer_provider_memory$options() returns a named list, the current values for all options.

Usage

tp <- tracer_provider_memory$new(opts = NULL)
tp$get_spans()
tracer_provider_memory$options()

tp$get_spans() erases the internal buffer of the tracer provider.

Arguments

• opts: Named list of options. See below.

Options

Memory exporter options

• buffer_size: buffer size, this is the maximum number of spans or metrics measurements that the provider can record. Must be positive. Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_MEMORY_TRACES_BUFFER_SIZE environment variable, or

  • the OTEL_R_EXPORTER_MEMORY_BUFFER_SIZE environment variable, or

  • the default is 100.

Examples

tracer_provider_memory$options()

Description

Writes spans to the standard output or error, or to a file. Useful for debugging.

Value

tracer_provider_stdstream$new() returns an otel::otel_tracer_provider object.

tracer_provider_stdstream$options() returns a named list, the current values of the options.

Usage

Externally:

OTEL_TRACES_EXPORTER=console
OTEL_TRACES_EXPORTER=stderr

From R:

tracer_provider_stdstream$new(opts = NULL)
tracer_provider_stdstream$options()

Arguments

opts: Named list of options. See below.

Options

Standard stream exporter options

• output: where to write the output. Can be

  • "stdout": write output to the standard output,

  • "stderr": write output to the standard error,

  • another string: write output to a file. (To write output to a file named "stdout" or "stderr", use a ⁠./⁠ prefix.)

  Value is set from

  • the opts argument, or

  • the OTEL_R_EXPORTER_STDSTREAM_TRACES_OUTPUT environment variable, or

  • the OTEL_R_EXPORTER_STDSTREAM_OUTPUT environment variable, or

  • the default is "stdout".

Examples

tracer_provider_stdstream$options()

Description

You can use this function to test that OpenTelemetry output is correctly generated for your package or application.

Usage

with_otel_record(
  expr,
  what = c("traces", "metrics"),
  tracer_opts = list(),
  meter_opts = list()
)

Arguments

Details

It evaluates the supplied expression, collects OpenTelemetry output from it and returns it.

Note: with_otel_record() cannot record logs yet.

with_otel_record() uses tracer_provider_memory and meter_provider_memory internally.

Value

A list with the output for each output type. Entries:

• value: value of expr.

• traces: the recorded spans, if requested in what.

• metrics: the recorded metrics measurements, if requested in what.

Examples

spns <- with_otel_record({
  trc <- otel::get_tracer("mytracer")
  spn1 <- trc$start_local_active_span()
  spn2 <- trc$start_local_active_span("my")
  spn2$end()
  spn1$end()
  NULL
})
spns