Mateusz Rzeszutek 27faf8f5b7 Make `HttpServerAttributesGetter` extend `NetServerAttributesGetter` (#9088) 1 年之前
..
src 27faf8f5b7 Make `HttpServerAttributesGetter` extend `NetServerAttributesGetter` (#9088) 1 年之前
README.md 2d7395c44b Introduce markdown lint check (#7175) 2 年之前
build.gradle.kts 9fe3761731 Document upper version limits (#6436) 2 年之前

README.md

Library Instrumentation for Ktor versions 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 KtorServerTracing feature. You must set the OpenTelemetry to use with the feature.

OpenTelemetry openTelemetry = initializeOpenTelemetryForMe()

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