You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,12 +21,13 @@ Provides instrumentation for Kotlin Coroutines. In particular it will trace the
21
21
22
22
## Supported Versions
23
23
24
+
Kotlin-Coroutines-Suspends - provides tracing of Kotlin Coroutine suspend functions across all versions.
24
25
Kotlin-Coroutines-1.0 - all 1.0.x versions.
25
26
Kotlin-Coroutines-1.1 - all 1.1.x versions.
26
27
Kotlin-Coroutines-1.2 - all 1.2.x and 1.3.x versions.
27
28
Kotlin-Coroutines-1.4 - all 1.4.x versions.
28
29
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.7 - all 1.7.x and later versions.
30
31
31
32
## Installation
32
33
To use this instrumentation.
@@ -45,12 +46,18 @@ You can also check any captured transactions for Metrics that start with 'Custom
45
46
46
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.
47
48
49
+
### Couroutine Name
50
+
For methods related to a coroutine (e.g. start, launch, runBlocking, etc.) it will use the CoroutineName if it is defined in the CoroutineContext or the simple name of the Coroutine class.
51
+
52
+
### Continuation String
53
+
Many of the metrics created by this instrumentation will use the continuation string which is the result of calling the toString method on a Continuation object. Typically this is either Continuation at ${getStackTraceElement() or the Java class name. In the case of subclasses of AbstractCoroutine it will be the coroutine name.
54
+
48
55
The following things are captured as part of the instrumentation
49
56
| Item | Metric Name format | Example |
50
57
| ---- | ---- | ---- |
51
58
| Suspend Functions | Custom/SuspendFunction/*ContinuationString*| Custom/SuspendFunction/Continuation at com.nrlabs.WithContextKt.main$doTaskOne(WithContext.kt:12) |
52
-
| Dispatched Tasks | Custom/DispatchedTask//*ContinuationString*| Custom/DispatchedTask/DispatchedContinuation[Dispatchers.Default, Continuation at kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt$createCoroutineUnintercepted...|
53
-
| Continuation but not Suspend | Custom/ContinuationWrapper/*ContinuationString*||
| Continuation but not Suspend | Custom/ContinuationWrapper/*ContinuationString*|Custom/ContinuationWrapper/resumeWith/createCoroutineFromSuspendFunction |
0 commit comments