Skip to content

Commit da036f0

Browse files
authored
Move advanced config to separate page (#5693)
1 parent db7830d commit da036f0

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Advanced configuration options
2+
3+
These are not meant to be used under normal circumstances.
4+
5+
If you find yourself needing to use any of them, it would be great if you could drop us an issue
6+
explaining why, so that we can try to come up with a better solution to address your need.
7+
8+
## Excluding specific classes from being instrumented
9+
10+
This can be used to completely silence spans from a given class/package.
11+
12+
Or as a quick workaround for an instrumentation bug, when byte code in one specific class is problematic.
13+
14+
This option should not be used lightly, as it can leave some instrumentation partially applied,
15+
which could have unknown side-effects.
16+
17+
| System property | Environment variable | Purpose |
18+
|--------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
19+
| otel.javaagent.exclude-classes | OTEL_JAVAAGENT_EXCLUDE_CLASSES | Suppresses all instrumentation for specific classes, format is "my.package.MyClass,my.package2.*" |

docs/suppressing-instrumentation.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -118,24 +118,6 @@ corresponding instrumentation `name`:
118118
underscores (`_`). For example, to suppress traces from `akka-actor` library, set
119119
`OTEL_INSTRUMENTATION_AKKA_ACTOR_ENABLED` to `false`.
120120

121-
### Even more fine-grained control
122-
123-
You can also exclude specific classes from being instrumented.
124-
125-
This can be useful to completely silence spans from a given class/package.
126-
127-
Or as a quick workaround for an instrumentation bug, when byte code in one specific class is problematic.
128-
129-
This option should not be used lightly, as it can leave some instrumentation partially applied,
130-
which could have unknown side-effects.
131-
132-
If you find yourself needing to use this, it would be great if you could drop us an issue explaining why,
133-
so that we can try to come up with a better solution to address your need.
134-
135-
| System property | Environment variable | Purpose |
136-
|--------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
137-
| otel.javaagent.exclude-classes | OTEL_JAVAAGENT_EXCLUDE_CLASSES | Suppresses all instrumentation for specific classes, format is "my.package.MyClass,my.package2.*" |
138-
139121
## Enable manual instrumentation only
140122

141123
You can suppress all auto instrumentations but have support for manual instrumentation with `@WithSpan` and normal API interactions by using

0 commit comments

Comments
 (0)