opentelemetry-java-instrume.../instrumentation/ktor/ktor-1.0/library
renovate[bot] c22bb598e5
fix(deps): update spotless packages to v7 (major) (#13004)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Lauri Tulmin <ltulmin@splunk.com>
2025-01-08 07:37:47 -08:00
..
src fix(deps): update spotless packages to v7 (major) (#13004) 2025-01-08 07:37:47 -08:00
README.md Rename ktor tracing to ktor telemetry (#12855) 2024-12-16 19:50:28 -08:00
build.gradle.kts chore(deps): update plugin org.jetbrains.kotlin.jvm to v2.1.0 (#12805) 2024-11-29 07:54:22 +02:00

README.md

Library Instrumentation for Ktor version 1.x

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-1.0</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>
</dependencies>

For Gradle, add to your dependencies:

implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-1.0:OPENTELEMETRY_VERSION")

Usage

Initialize instrumentation by installing the KtorServerTelemetry feature. You must set the OpenTelemetry to use with the feature.

OpenTelemetry openTelemetry = ...

embeddedServer(Netty, 8080) {
  install(KtorServerTelemetry) {
    setOpenTelemetry(openTelemetry)
  }
}