diff --git a/instrumentation/active_job/README.md b/instrumentation/active_job/README.md index 52ad445101..fde00053e5 100644 --- a/instrumentation/active_job/README.md +++ b/instrumentation/active_job/README.md @@ -30,6 +30,27 @@ OpenTelemetry::SDK.configure do |c| end ``` +## Configuration Options + +The instrumentation supports the following configuration options: + +- **span_naming:** Determines how span names are generated. + - `:job_class` – Span names are set to ` `. + - `:queue` – Span names are set to ` `. + - Default: `:queue` +- **force_flush:** If enabled, all completed spans are synchronously flushed at + the end of each job execution. This is recommended for job systems that fork + worker processes, such as Resque. + - Default: `false` +- **propagation_style:** Controls how job execution traces are related to the + trace where the job was enqueued. + - `:link` – The job runs in a separate trace, with its initial span linked to + the enqueuing span via a Span Link. + - `:child` – The job runs in the same trace, as a direct child of the + enqueuing span. + - `:none` – No explicit link between the job execution and the enqueuing span. + - Default: `:link` + ## Active Support Instrumentation Earlier versions of this instrumentation relied on registering custom `around_perform` hooks in order to deal with limitations