Add micrometer library doc (#9856)

This commit is contained in:
Trask Stalnaker 2023-11-14 11:17:39 -08:00 committed by GitHub
parent c973b9ebd4
commit f993e9a498
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 0 deletions

View File

@ -16,6 +16,9 @@
},
{
"pattern": "^http(s)?://logback\\.qos\\.ch"
},
{
"pattern": "^https://micrometer\\.io"
}
]
}

View File

@ -0,0 +1,38 @@
# Micrometer Instrumentation for Micrometer version 1.5 and higher
This module provides a [Micrometer registry](https://micrometer.io/docs/concepts#_registry) which
sends Micrometer metrics to the
[OpenTelemetry Metrics SDK](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk/metrics).
## Quickstart
### Add these dependencies to your project
Replace `OPENTELEMETRY_VERSION` with the [latest
release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-micrometer-1.5).
For Maven, add to your `pom.xml` dependencies:
```xml
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-micrometer-1.5</artifactId>
<version>OPENTELEMETRY_VERSION</version>
</dependency>
</dependencies>
```
For Gradle, add to your dependencies:
```groovy
implementation("io.opentelemetry.instrumentation:opentelemetry-micrometer-1.5:OPENTELEMETRY_VERSION")
```
### Usage
The instrumentation library provides an implementation of `MeterRegistry` to bridge Micrometer API to OpenTelemetry Metrics.
```java
MeterRegistry meterRegistry = OpenTelemetryMeterRegistry.builder(openTelemetry).build();
```