Implements https://github.com/open-telemetry/opentelemetry-specification/issues/2998 --------- Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> |
||
---|---|---|
.. | ||
src | ||
README.md | ||
build.gradle.kts |
README.md
Library Instrumentation for Ktor version 2.0 and higher
This package contains libraries to help instrument Ktor. Currently, only server instrumentation is supported.
Quickstart
Add these dependencies to your project
Replace OPENTELEMETRY_VERSION
with the latest
release.
For Maven, add to your pom.xml
dependencies:
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-ktor-2.0</artifactId>
<version>OPENTELEMETRY_VERSION</version>
</dependency>
</dependencies>
For Gradle, add to your dependencies:
implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-2.0:OPENTELEMETRY_VERSION")
Usage
Initializing server instrumentation
Initialize instrumentation by installing the KtorServerTracing
feature. You must set the OpenTelemetry
to use with
the feature.
OpenTelemetry openTelemetry = initializeOpenTelemetryForMe()
embeddedServer(Netty, 8080) {
install(KtorServerTracing) {
setOpenTelemetry(openTelemetry)
}
}