Browse Source

Document instrumentation flags (#10156)

Lauri Tulmin 1 year ago
parent
commit
a43ac68d51

+ 5 - 0
instrumentation/jdbc/README.md

@@ -0,0 +1,5 @@
+# Settings for the JDBC instrumentation
+
+| System property                                         | Type    | Default | Description                            |
+|---------------------------------------------------------|---------|---------|----------------------------------------|
+| `otel.instrumentation.jdbc.statement-sanitizer.enabled` | Boolean | `true`  | Enables the DB statement sanitization. |

+ 7 - 0
instrumentation/kafka/README.md

@@ -0,0 +1,7 @@
+# Settings for the Kafka instrumentation
+
+| System property                                           | Type    | Default | Description                                                                                                                    |
+|-----------------------------------------------------------| ------- |---------|--------------------------------------------------------------------------------------------------------------------------------|
+| `otel.instrumentation.kafka.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes.                                                                            |
+| `otel.instrumentation.kafka.client-propagation.enabled`   | Boolean | `true`  | Enable context propagation for kafka message producer.                                                                         |
+| `otel.instrumentation.kafka.metric-reporter.enabled`      | Boolean | `true`  | Enable kafka consumer and producer metrics. **Deprecated**, disable instrumentation with name `kafka-clients-metrics` instead. |

+ 5 - 0
instrumentation/mongo/README.md

@@ -0,0 +1,5 @@
+# Settings for the MongoDB Java Driver instrumentation
+
+| System property                                          | Type    | Default | Description                            |
+|----------------------------------------------------------|---------|---------|----------------------------------------|
+| `otel.instrumentation.mongo.statement-sanitizer.enabled` | Boolean | `true`  | Enables the DB statement sanitization. |

+ 5 - 0
instrumentation/oshi/README.md

@@ -0,0 +1,5 @@
+# Settings for the OSHI instrumentation
+
+| System property                                           | Type    | Default | Description              |
+|-----------------------------------------------------------| ------- | ------- |--------------------------|
+| `otel.instrumentation.oshi.experimental-metrics.enabled`  | Boolean | `false` | Enable the OSHI metrics. |

+ 5 - 0
instrumentation/quartz-2.0/README.md

@@ -0,0 +1,5 @@
+# Settings for the Quartz instrumentation
+
+| System property                                            | Type    | Default | Description                                         |
+| ---------------------------------------------------------- | ------- | ------- | --------------------------------------------------- |
+| `otel.instrumentation.quartz.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. |