Skip to content

Commit cb5f73c

Browse files
committed
Enhance README with additional configuration options for ActiveJob instrumentation
1 parent 589de6a commit cb5f73c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

instrumentation/active_job/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,25 @@ OpenTelemetry::SDK.configure do |c|
2222
end
2323
```
2424

25+
The instrumentation supports the following configuration options:
26+
27+
- **span_naming:** Determines how span names are generated.
28+
- `:job_class` – Span names are set to `<job class name> <operation>`.
29+
- `:queue` – Span names are set to `<queue name> <operation>`.
30+
- Default: `:queue`
31+
- **force_flush:** If enabled, all completed spans are synchronously flushed at
32+
the end of each job execution. This is recommended for job systems that fork
33+
worker processes, such as Resque.
34+
- Default: `false`
35+
- **propagation_style:** Controls how job execution traces are related to the
36+
trace where the job was enqueued.
37+
- `:link` – The job runs in a separate trace, with its initial span linked to
38+
the enqueuing span via a Span Link.
39+
- `:child` – The job runs in the same trace, as a direct child of the
40+
enqueuing span.
41+
- `:none` – No explicit link between the job execution and the enqueuing span.
42+
- Default: `:link`
43+
2544
Alternatively, you can also call `use_all` to install all the available instrumentation.
2645

2746
```ruby

0 commit comments

Comments
 (0)