Document flags used in the runtime telemetry instrumentation (#10191)

open-telemetry · Jan 9, 2024 · a7780c3 · a7780c3
1 parent 9c1de50
commit a7780c3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/instrumentation/runtime-telemetry/README.md b/instrumentation/runtime-telemetry/README.md
@@ -0,0 +1,9 @@
+# Settings for the Runtime Telemetry instrumentation
+
+| System property                                                          | Type    | Default | Description                                                       |
+|--------------------------------------------------------------------------|---------|---------|-------------------------------------------------------------------|
+| `otel.instrumentation.runtime-telemetry.emit-experimental-telemetry`     | Boolean | `false` | Enable the capture of experimental metrics.                       |
+| `otel.instrumentation.runtime-telemetry-java17.enable-all`               | Boolean | `false` | Enable the capture of all JFR based metrics.                      |
+| `otel.instrumentation.runtime-telemetry-java17.enabled`                  | Boolean | `false` | Enable the capture of JFR based metrics.                          |
+| `otel.instrumentation.runtime-telemetry.package-emitter.enabled`         | Boolean | `false` | Enable creating events for JAR libraries used by the application. |
+| `otel.instrumentation.runtime-telemetry.package-emitter.jars-per-second` | Integer | 10      | The number of JAR files processed per second.                     |