From a7780c36f1a9dade3665b75d1b327b9c587e5024 Mon Sep 17 00:00:00 2001 From: Lauri Tulmin Date: Wed, 10 Jan 2024 01:01:20 +0200 Subject: [PATCH] Document flags used in the runtime telemetry instrumentation (#10191) --- instrumentation/runtime-telemetry/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 instrumentation/runtime-telemetry/README.md diff --git a/instrumentation/runtime-telemetry/README.md b/instrumentation/runtime-telemetry/README.md new file mode 100644 index 0000000000..9baab6e131 --- /dev/null +++ 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. |