Skip to content

Commit b1fe968

Browse files
dan-corneanukaylareopellearielvalentin
authored
docs: Enhance README (#1711)
feat: Enhance README Document configuration options for ActiveJob instrumentation. Co-authored-by: Kayla Reopelle <[email protected]> Co-authored-by: Ariel Valentin <[email protected]>
1 parent cf12317 commit b1fe968

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

instrumentation/active_job/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,27 @@ OpenTelemetry::SDK.configure do |c|
3030
end
3131
```
3232

33+
## Configuration Options
34+
35+
The instrumentation supports the following configuration options:
36+
37+
- **span_naming:** Determines how span names are generated.
38+
- `:job_class` – Span names are set to `<job class name> <operation>`.
39+
- `:queue` – Span names are set to `<queue name> <operation>`.
40+
- Default: `:queue`
41+
- **force_flush:** If enabled, all completed spans are synchronously flushed at
42+
the end of each job execution. This is recommended for job systems that fork
43+
worker processes, such as Resque.
44+
- Default: `false`
45+
- **propagation_style:** Controls how job execution traces are related to the
46+
trace where the job was enqueued.
47+
- `:link` – The job runs in a separate trace, with its initial span linked to
48+
the enqueuing span via a Span Link.
49+
- `:child` – The job runs in the same trace, as a direct child of the
50+
enqueuing span.
51+
- `:none` – No explicit link between the job execution and the enqueuing span.
52+
- Default: `:link`
53+
3354
## Active Support Instrumentation
3455

3556
Earlier versions of this instrumentation relied on registering custom `around_perform` hooks in order to deal with limitations

0 commit comments

Comments
 (0)