[#8472] Update description for Coroutines plugin

pinpoint-apm · Dec 9, 2021 · 5832a51 · 5832a51
1 parent b7920e6
commit 5832a51
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/agent/src/main/resources/profiles/local/pinpoint.config b/agent/src/main/resources/profiles/local/pinpoint.config
@@ -1254,6 +1254,21 @@ profiler.rocketmq.basePackage=
 # v1.0.1 ~
 ###########################################################
 profiler.kotlin.coroutines.enable=false
+# Coroutine Example
+# runBlocking(CoroutineName("pinpoint-coroutines")) {
+#   // has same name("pinpoint-coroutines") with parentContext
+#   launch {
+#   }
+#   // has name("async-pinpoint-coroutines")
+#   async(CoroutineName("async-pinpoint-coroutines")) { //
+#   }
+# }
+# 1. For trace everyone in the above situation
+#   profiler.kotlin.coroutines.name.include=pinpoint-coroutines,async-pinpoint-coroutines
+# 2. For trace only pinpoint-coroutines context
+#   profiler.kotlin.coroutines.name.include=pinpoint-coroutines
+# Note) Trace "async-pinpoint-coroutines" is impossible. This is because the above root connection does not exist.
+#
 # Only perfect string matching is supported. (If you do not include any value, it will not be tracked.)
 # Comma separated list of coroutines name
 # eg) profiler.kotlin.coroutines.name.include=CoroutineMyJob1,CoroutineMyJob2

diff --git a/agent/src/main/resources/profiles/release/pinpoint.config b/agent/src/main/resources/profiles/release/pinpoint.config
@@ -1277,6 +1277,21 @@ profiler.rocketmq.basePackage=
 # v1.0.1 ~
 ###########################################################
 profiler.kotlin.coroutines.enable=false
+## Coroutine Example
+# runBlocking(CoroutineName("pinpoint-coroutines")) {
+#   // has same name("pinpoint-coroutines") with parentContext
+#   launch {
+#   }
+#   // has name("async-pinpoint-coroutines")
+#   async(CoroutineName("async-pinpoint-coroutines")) { //
+#   }
+# }
+# 1. For trace everyone in the above situation
+#   profiler.kotlin.coroutines.name.include=pinpoint-coroutines,async-pinpoint-coroutines
+# 2. For trace only pinpoint-coroutines context
+#   profiler.kotlin.coroutines.name.include=pinpoint-coroutines
+# Note) Trace "async-pinpoint-coroutines" is impossible. This is because the above root connection does not exist.
+#
 # Only perfect string matching is supported. (If you do not include any value, it will not be tracked.)
 # Comma separated list of coroutines name
 # eg) profiler.kotlin.coroutines.name.include=CoroutineMyJob1,CoroutineMyJob2