Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 5.63 KB

configure.md

File metadata and controls

74 lines (53 loc) · 5.63 KB
Raw

Configuration

Configure the Elastic Distribution of OpenTelemetry PHP (EDOT PHP) to send data to Elastic.

Configuration method

Configuration of the OpenTelemetry SDK should be performed through the mechanisms documented on the OpenTelemetry website. EDOT PHP is typically configured with OTEL_* environment variables defined by the OpenTelemetry spec. For example:

Configuration options

Because the Elastic Distribution of OpenTelemetry PHP is an extension of the OpenTelemetry PHP SDK, it supports:

OpenTelemetry configuration options

EDOT PHP supports all configuration options listed in the OpenTelemetry General SDK Configuration documentation and OpenTelemetry PHP SDK.

Configuration options that are only available in EDOT PHP

In addition to general OpenTelemetry configuration options, there are two kinds of configuration options that are only available in EDOT PHP.

Elastic-authored options that are not yet available upstream

Additional OTEL_ options that Elastic plans to contribute upstream to the OpenTelemetry PHP SDK, but are not yet available in the OpenTelemetry PHP SDK.

Currently there are no additional OTEL_ options waiting to be contributed upstream.

Elastic-specific options

ELASTIC_OTEL_ options that are specific to Elastic and will always live in EDOT PHP (in other words, they will not be added upstream):

Option(s) Default Accepted values Description
ELASTIC_OTEL_ENABLED true true or false Enables the automatic bootstrapping of instrumentation code
ELASTIC_OTEL_ASYNC_TRANSPORT true true or false Use asynchronous (background) transfer of traces, metrics and logs. If false - brings back original OpenTelemetry SDK transfer modes
ELASTIC_OTEL_ASYNC_TRANSPORT_SHUTDOWN_TIMEOUT 30s interger numberwith time duration. Set to 0 to disable the timeout. Optional units: ms (default), s, m Timeout after which the asynchronous (background) transfer will interrupt data transmission during process termination
ELASTIC_OTEL_MAX_SEND_QUEUE_SIZE 2MB integer number with optional units: B, MB or GB Set the maximum buffer size for asynchronous (background) transfer. It is set per worker process.
ELASTIC_OTEL_VERIFY_SERVER_CERT true true or false Enables server certificate verification for asynchronous sending
ELASTIC_OTEL_LOG_FILE Filesystem path Log file name. You can use the %p placeholder where the process ID will appear in the file name, and %t where the timestamp will appear. Please note that the PHP process must have write permissions for the specified path.
ELASTIC_OTEL_LOG_LEVEL_FILE OFF OFF, CRITICAL, ERROR, WARNING, INFO, DEBUG, TRACE Log level for file sink. Set to OFF if you don't want to log to file.
ELASTIC_OTEL_LOG_LEVEL_STDERR OFF OFF, CRITICAL, ERROR, WARNING, INFO, DEBUG, TRACE Log level for the stderr sink. Set to OFF if you don't want to log to a file. This sink is recommended when running the application in a container.
ELASTIC_OTEL_LOG_LEVEL_SYSLOG OFF OFF, CRITICAL, ERROR, WARNING, INFO, DEBUG, TRACE Log level for file sink. Set to OFF if you don't want to log to file. This sink is recommended when you don't have write access to file system.
ELASTIC_OTEL_LOG_FEATURES Comma separated string with FEATURE=LEVEL pairs.
Supported features:
ALL, MODULE, REQUEST, TRANSPORT, BOOTSTRAP, HOOKS, INSTRUMENTATION		 Allows selective setting of log level for features. For example, "ALL=info,TRANSPORT=trace" will result in all other features logging at the info level, while the TRANSPORT feature logs at the trace level. It should be noted that the appropriate log level must be set for the sink - for our example, this would be TRACE.
ELASTIC_OTEL_TRANSACTION_SPAN_ENABLED true true or false Enables automatic creation of transaction (root) spans for the webserver SAPI. The name of the span will correspond to the request method and path.
ELASTIC_OTEL_TRANSACTION_SPAN_ENABLED_CLI true true or false Enables automatic creation of transaction (root) spans for the CLI SAPI. The name of the span will correspond to the script name.
ELASTIC_OTEL_TRANSACTION_URL_GROUPS Comma-separated list of wildcard expressions Allows grouping multiple URL paths using wildcard expressions, such as /user/*. For example, /user/Alice and /user/Bob will be mapped to the transaction name /user/*.