Configuration Directives

You can configure these directives based on your deployment needs. A dash ("-") in a table cell indicates that this column is not relevant to the directive.

Directives Default Value Configuration Requirement Remarks

NginxModuleEnabled

 ON Optional Required to instrument NGINX web server.

NginxModuleOtelSpanExporter

 otlp Optional

Specify the span exporter to be used. Currently, the supported values are otlp and ostream.

NginxModuleOtelExporterEndpoint

 Required

OpenTelemetry exports to this endpoint. For example,

docker.for.mac.localhost:4317
NginxModuleOtelSpanProcessor batch Optional Supported values are simple and batch.

NginxModuleOtelSampler

AlwaysOn

 Optional

Supported values are AlwaysOn and AlwaysOff.

NginxModuleOtelMaxQueueSize

 2048 Optional

The maximum span queue size. After this size limit is reached, spans are dropped.

NginxModuleOtelScheduledDelayMillis

 5000 Optional

The delay interval in milliseconds between two consecutive exports.

NginxModuleOtelExportTimeoutMillis

 30000 Optional

The time duration in milliseconds that export can run before it is canceled.

NginxModuleOtelMaxExportBatchSize

 512 Optional

The maximum batch size of every export. It must be smaller or equal to maxQueueSize.

NginxModuleServiceName

 - Required

A namespace for the ServiceName.

NginxModuleServiceNamespace

 - Required

Logical name of the service.

NginxModuleServiceInstanceId

 - Required

The string ID of the service instance.

NginxModuleTraceAsError

 - Optional

Trace level for logging to Apache log.

NginxModuleWebserverContext

 - Optional

Takes 3 values (separated by space) ServiceName, ServiceNamespace, and ServiceInstanceId.

NginxModuleSegmentType

 - Optional

Specify the string ( FIRST/LAST/CUSTOM) to be filtered for the span name creation.

NginxModuleSegmentParameter

 - Optional

Specify the segment count or segment

numbers that you want to display for the span creation.