Skip to content
This repository was archived by the owner on Dec 2, 2025. It is now read-only.

Commit 41e8e88

Browse files
committed
Merge branch 'fix_not_linking' of https://github.com/newrelic/newrelic-java-kotlin-coroutines into fix_not_linking
2 parents 5c09a21 + 8b47136 commit 41e8e88

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ Provides instrumentation for Kotlin Coroutines. In particular it will trace the
2424
Kotlin-Coroutines-1.0 - all 1.0.x versions.
2525
Kotlin-Coroutines-1.1 - all 1.1.x versions.
2626
Kotlin-Coroutines-1.2 - all 1.2.x and 1.3.x versions.
27-
Kotlin-Coroutines-1.4 - all 1.4.x and later versions.
27+
Kotlin-Coroutines-1.4 - all 1.4.x versions.
28+
Kotlin-Coroutines-1.5 - all 1.5.x and 1.6.x versions.
29+
Kotlin-Coroutines-1.7 - all 1.7.x versions.
30+
Kotlin-Coroutines-1.8 - all 1.8.x versions and later.
2831

2932
## Installation
3033
To use this instrumentation.
@@ -37,9 +40,18 @@ Restart the application.
3740
The easiest way to see if the instrumentation has been loaded by the Java Agent is to look for the Java Agent UI's Metric Explorer and enter "supportability/weaveinstrumentation/loaded/com.newrelic.instrumentation.labs.kotlin-coroutines". If a metric is reported then the agent has loaded the instrumentation appropriate to the version of Kotlin Coroutines that you are using.
3841
If no metric is displayed, then check for "supportability/weaveinstrumentation/skipped/com.newrelic.instrumentation.labs.kotlin-coroutines". If no metrics are displayed verify that the instrumentation jars have been deployed to the extensions directory and that the user id that runs the application has read access.
3942

43+
You can also check any captured transactions for Metrics that start with 'Custom/SuspendFunction/' or 'Custom/DispatchedTask'
44+
4045
## Getting Started
4146

42-
After deployment of the instrumentation jars, you should be able to see the invocation of a coroutine from start to finish across any threads that it executes on.
47+
After deployment of the instrumentation jars, you should be able to see the invocation of a coroutine from start to finish across any threads that it executes on.
48+
49+
The following things are captured as part of the instrumentation
50+
| Item | Metric Name format | Example |
51+
| ---- | ---- | ---- |
52+
| Suspend Functions | Custom/SuspendFunction/*ContinuationString* | Custom/SuspendFunction/Continuation at com.nrlabs.WithContextKt.main$doTaskOne(WithContext.kt:12) |
53+
| Dispatched Tasks | Custom/DispatchedTask | Custom/DispatchedTask/DispatchedContinuation[Dispatchers.Default, Continuation at kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt$createCoroutineUnintercepted... |
54+
| Continuation but not Suspend | Custom/
4355

4456
## Usage
4557

0 commit comments

Comments
 (0)