Skip to content

Commit f993e9a

Browse files
authored
Add micrometer library doc (#9856)
1 parent c973b9e commit f993e9a

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

.github/scripts/markdown-link-check-config.json

+3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
},
1717
{
1818
"pattern": "^http(s)?://logback\\.qos\\.ch"
19+
},
20+
{
21+
"pattern": "^https://micrometer\\.io"
1922
}
2023
]
2124
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Micrometer Instrumentation for Micrometer version 1.5 and higher
2+
3+
This module provides a [Micrometer registry](https://micrometer.io/docs/concepts#_registry) which
4+
sends Micrometer metrics to the
5+
[OpenTelemetry Metrics SDK](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk/metrics).
6+
7+
## Quickstart
8+
9+
### Add these dependencies to your project
10+
11+
Replace `OPENTELEMETRY_VERSION` with the [latest
12+
release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-micrometer-1.5).
13+
14+
For Maven, add to your `pom.xml` dependencies:
15+
16+
```xml
17+
<dependencies>
18+
<dependency>
19+
<groupId>io.opentelemetry.instrumentation</groupId>
20+
<artifactId>opentelemetry-micrometer-1.5</artifactId>
21+
<version>OPENTELEMETRY_VERSION</version>
22+
</dependency>
23+
</dependencies>
24+
```
25+
26+
For Gradle, add to your dependencies:
27+
28+
```groovy
29+
implementation("io.opentelemetry.instrumentation:opentelemetry-micrometer-1.5:OPENTELEMETRY_VERSION")
30+
```
31+
32+
### Usage
33+
34+
The instrumentation library provides an implementation of `MeterRegistry` to bridge Micrometer API to OpenTelemetry Metrics.
35+
36+
```java
37+
MeterRegistry meterRegistry = OpenTelemetryMeterRegistry.builder(openTelemetry).build();
38+
```

0 commit comments

Comments
 (0)