Browse Source

Move advanced config to separate page (#5693)

Trask Stalnaker 3 years ago
parent
commit
da036f0b50
2 changed files with 19 additions and 18 deletions
  1. 19 0
      docs/advanced-configuration-options.md
  2. 0 18
      docs/suppressing-instrumentation.md

+ 19 - 0
docs/advanced-configuration-options.md

@@ -0,0 +1,19 @@
+# Advanced configuration options
+
+These are not meant to be used under normal circumstances.
+
+If you find yourself needing to use any of them, it would be great if you could drop us an issue
+explaining why, so that we can try to come up with a better solution to address your need.
+
+## Excluding specific classes from being instrumented
+
+This can be used to completely silence spans from a given class/package.
+
+Or as a quick workaround for an instrumentation bug, when byte code in one specific class is problematic.
+
+This option should not be used lightly, as it can leave some instrumentation partially applied,
+which could have unknown side-effects.
+
+| System property                | Environment variable           | Purpose                                                                                           |
+|--------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
+| otel.javaagent.exclude-classes | OTEL_JAVAAGENT_EXCLUDE_CLASSES | Suppresses all instrumentation for specific classes, format is "my.package.MyClass,my.package2.*" |

+ 0 - 18
docs/suppressing-instrumentation.md

@@ -118,24 +118,6 @@ corresponding instrumentation `name`:
 underscores (`_`). For example, to suppress traces from `akka-actor` library, set
 `OTEL_INSTRUMENTATION_AKKA_ACTOR_ENABLED` to `false`.
 
-### Even more fine-grained control
-
-You can also exclude specific classes from being instrumented.
-
-This can be useful to completely silence spans from a given class/package.
-
-Or as a quick workaround for an instrumentation bug, when byte code in one specific class is problematic.
-
-This option should not be used lightly, as it can leave some instrumentation partially applied,
-which could have unknown side-effects.
-
-If you find yourself needing to use this, it would be great if you could drop us an issue explaining why,
-so that we can try to come up with a better solution to address your need.
-
-| System property                | Environment variable           | Purpose                                                                                           |
-|--------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
-| otel.javaagent.exclude-classes | OTEL_JAVAAGENT_EXCLUDE_CLASSES | Suppresses all instrumentation for specific classes, format is "my.package.MyClass,my.package2.*" |
-
 ## Enable manual instrumentation only
 
 You can suppress all auto instrumentations but have support for manual instrumentation with `@WithSpan` and normal API interactions by using