Skip to content

Commit a4ebcac

Browse files
committed
update docs
1 parent 24671dd commit a4ebcac

File tree

3 files changed

+24
-13
lines changed

3 files changed

+24
-13
lines changed

instrumentation/ktor/ktor-1.0/library/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Library Instrumentation for Ktor version 1.x
22

3-
This package contains libraries to help instrument Ktor. Currently, only server instrumentation is supported.
3+
This package contains libraries to help instrument Ktor. Currently, only server instrumentation is
4+
supported.
45

56
## Quickstart
67

@@ -12,6 +13,7 @@ release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20
1213
For Maven, add to your `pom.xml` dependencies:
1314

1415
```xml
16+
1517
<dependencies>
1618
<dependency>
1719
<groupId>io.opentelemetry.instrumentation</groupId>
@@ -29,14 +31,15 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-1.0:OPENTELE
2931

3032
## Usage
3133

32-
Initialize instrumentation by installing the `KtorServerTracing` feature. You must set the `OpenTelemetry` to use with
34+
Initialize instrumentation by installing the `KtorServerTelemetry` feature. You must set the
35+
`OpenTelemetry` to use with
3336
the feature.
3437

3538
```kotlin
3639
OpenTelemetry openTelemetry = ...
3740

3841
embeddedServer(Netty, 8080) {
39-
install(KtorServerTracing) {
42+
install(KtorServerTelemetry) {
4043
setOpenTelemetry(openTelemetry)
4144
}
4245
}

instrumentation/ktor/ktor-2.0/library/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Library Instrumentation for Ktor version 2.x
22

3-
This package contains libraries to help instrument Ktor. Server and client instrumentations are supported.
3+
This package contains libraries to help instrument Ktor. Server and client instrumentations are
4+
supported.
45

56
## Quickstart
67

@@ -12,6 +13,7 @@ release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20
1213
For Maven, add to your `pom.xml` dependencies:
1314

1415
```xml
16+
1517
<dependencies>
1618
<dependency>
1719
<groupId>io.opentelemetry.instrumentation</groupId>
@@ -31,29 +33,31 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-2.0:OPENTELE
3133

3234
## Initializing server instrumentation
3335

34-
Initialize instrumentation by installing the `KtorServerTracing` feature. You must set the `OpenTelemetry` to use with
36+
Initialize instrumentation by installing the `KtorServerTelemetry` feature. You must set the
37+
`OpenTelemetry` to use with
3538
the feature.
3639

3740
```kotlin
3841
val openTelemetry: OpenTelemetry = ...
3942

4043
embeddedServer(Netty, 8080) {
41-
install(KtorServerTracing) {
44+
install(KtorServerTelemetry) {
4245
setOpenTelemetry(openTelemetry)
4346
}
4447
}
4548
```
4649

4750
## Initializing client instrumentation
4851

49-
Initialize instrumentation by installing the `KtorClientTracing` feature. You must set the `OpenTelemetry` to use with
52+
Initialize instrumentation by installing the `KtorClientTelemetry` feature. You must set the
53+
`OpenTelemetry` to use with
5054
the feature.
5155

5256
```kotlin
5357
val openTelemetry: OpenTelemetry = ...
5458

5559
val client = HttpClient {
56-
install(KtorClientTracing) {
60+
install(KtorClientTelemetry) {
5761
setOpenTelemetry(openTelemetry)
5862
}
5963
}

instrumentation/ktor/ktor-3.0/library/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Library Instrumentation for Ktor version 3.0 and higher
22

3-
This package contains libraries to help instrument Ktor. Server and client instrumentations are supported.
3+
This package contains libraries to help instrument Ktor. Server and client instrumentations are
4+
supported.
45

56
## Quickstart
67

@@ -12,6 +13,7 @@ release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20
1213
For Maven, add to your `pom.xml` dependencies:
1314

1415
```xml
16+
1517
<dependencies>
1618
<dependency>
1719
<groupId>io.opentelemetry.instrumentation</groupId>
@@ -31,29 +33,31 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-3.0:OPENTELE
3133

3234
## Initializing server instrumentation
3335

34-
Initialize instrumentation by installing the `KtorServerTracing` feature. You must set the `OpenTelemetry` to use with
36+
Initialize instrumentation by installing the `KtorServerTelemetry` feature. You must set the
37+
`OpenTelemetry` to use with
3538
the feature.
3639

3740
```kotlin
3841
val openTelemetry: OpenTelemetry = ...
3942

4043
embeddedServer(Netty, 8080) {
41-
install(KtorServerTracing) {
44+
install(KtorServerTelemetry) {
4245
setOpenTelemetry(openTelemetry)
4346
}
4447
}
4548
```
4649

4750
## Initializing client instrumentation
4851

49-
Initialize instrumentation by installing the `KtorClientTracing` feature. You must set the `OpenTelemetry` to use with
52+
Initialize instrumentation by installing the `KtorClientTelemetry` feature. You must set the
53+
`OpenTelemetry` to use with
5054
the feature.
5155

5256
```kotlin
5357
val openTelemetry: OpenTelemetry = ...
5458

5559
val client = HttpClient {
56-
install(KtorClientTracing) {
60+
install(KtorClientTelemetry) {
5761
setOpenTelemetry(openTelemetry)
5862
}
5963
}

0 commit comments

Comments
 (0)