Skip to content

Commit 353ec10

Browse files
document default disabled micrometer instrumentation (#13492)
Co-authored-by: Jay DeLuca <[email protected]>
1 parent 4faccbc commit 353ec10

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/supported-libraries.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ These are the supported libraries and frameworks:
101101
| [Log4j 1](https://logging.apache.org/log4j/1.2/) | 1.2+ | N/A | none |
102102
| [Log4j 2](https://logging.apache.org/log4j/2.x/) | 2.11+ | [opentelemetry-log4j-appender-2.17](../instrumentation/log4j/log4j-appender-2.17/library),<br>[opentelemetry-log4j-context-data-2.17-autoconfigure](../instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure) | none |
103103
| [Logback](http://logback.qos.ch/) | 1.0+ | [opentelemetry-logback-appender-1.0](../instrumentation/logback/logback-appender-1.0/library),<br>[opentelemetry-logback-mdc-1.0](../instrumentation/logback/logback-mdc-1.0/library) | none |
104-
| [Micrometer](https://micrometer.io/) | 1.5+ | [opentelemetry-micrometer-1.5](../instrumentation/micrometer/micrometer-1.5/library) | none |
104+
| [Micrometer](https://micrometer.io/) | 1.5+ (disabled by default) | [opentelemetry-micrometer-1.5](../instrumentation/micrometer/micrometer-1.5/library) | none |
105105
| [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/) | 3.1+ | [opentelemetry-mongo-3.1](../instrumentation/mongo/mongo-3.1/library) | [Database Client Spans], [Database Client Metrics]&nbsp;[6] |
106106
| [MyBatis](https://mybatis.org/mybatis-3/) | 3.2+ | N/A | none |
107107
| [Netty HTTP codec [5]](https://github.com/netty/netty) | 3.8+ | [opentelemetry-netty-4.1](../instrumentation/netty/netty-4.1/library) | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics] |
@@ -230,12 +230,16 @@ These are the JVMs and operating systems that the integration tests are run agai
230230

231231
## Disabled instrumentations
232232

233-
Some instrumentations can produce too many spans and make traces very noisy.
233+
Some instrumentations can produce too many spans and metrics and thus create a lot of noise.
234234
For this reason, the following instrumentations are disabled by default:
235235

236236
- `jdbc-datasource` which creates spans whenever the `java.sql.DataSource#getConnection` method is called.
237237
- `dropwizard-metrics` which might create a very low quality metrics data, because of lack of label/attribute support
238238
in the Dropwizard metrics API.
239+
- `micrometer` which might create high number of metrics due to being broadly used in libraries.
239240

240241
To enable them, add the `otel.instrumentation.<name>.enabled` system property:
241-
`-Dotel.instrumentation.jdbc-datasource.enabled=true`
242+
243+
- `-Dotel.instrumentation.jdbc-datasource.enabled=true`
244+
- `-Dotel.instrumentation.dropwizard-metrics.enabled=true`
245+
- `-Dotel.instrumentation.micrometer.enabled=true`

0 commit comments

Comments
 (0)