-
Notifications
You must be signed in to change notification settings - Fork 332
Add Scala concurrent plugin #1048
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
404f6fb
WIP
9ce7f3f
Add initial scala instrumentation for Future
milanvdm e0a4335
Remove test-dependency
milanvdm e57e2d8
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm 3ef57c0
Add first test approach
milanvdm 2dd336d
Use Java for method matching
milanvdm 167ecde
Add dummy test using Scala
milanvdm 90d0b6f
Add java-version
milanvdm 1b5b369
Add first matching instrumentation test
milanvdm f20a929
WIP
milanvdm b2d2bb7
Use MUnit
milanvdm 2feb98f
Cleanup pom
milanvdm 0af62ce
Add Future instrumentation
milanvdm f97b0b1
Add tests
milanvdm 649207b
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm 324ce67
Add plugin to release process
milanvdm 9d0eb39
Instrument ExecutionContext
milanvdm 7ab2834
Merge branch 'master' into add-scala-executor-apm
milanvdm ee6da7d
Add onStream instrumentation on AsyncHandler
milanvdm ec2b7eb
Add StreamHandler tests
milanvdm d9e0762
Merge branch 'keep-spans-active-on-stream-async-http' into add-scala-…
milanvdm 84417b0
Add Promise instrumentation
milanvdm 199e514
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm ad42993
Cleanup
milanvdm 49bca5f
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm e41f63c
Fix versions
milanvdm a0375b7
Make sure spans are not recycled
milanvdm accd469
Cleanup Java 9 compilers
milanvdm 7843966
Add docs
milanvdm 0f7b257
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm f9b8e56
Fix merge
milanvdm 063ed39
Remove Java version
milanvdm 6c638d9
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm 40033fa
Improve testing for edge cases
milanvdm 5ee2b3b
Simplify failing test
milanvdm 1721794
Add extra failing test on Future.sequence
milanvdm 737bb0e
Merge branch 'master' into add-scala-executor-apm
felixbarny 1885c8e
Add java apm dependency to test
milanvdm c893ac0
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm f844049
Bump to new snapshot version
milanvdm 0f530a0
Start tracer
milanvdm c6a6581
Merge remote-tracking branch 'upstream/master' into add-scala-executo…
milanvdm b68d3d2
Merge branch 'master' into add-scala-executor-apm
felixbarny File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <artifactId>apm-agent-plugins</artifactId> | ||
| <groupId>co.elastic.apm</groupId> | ||
| <version>1.15.1-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <artifactId>apm-scala-concurrent-plugin</artifactId> | ||
| <name>${project.groupId}:${project.artifactId}</name> | ||
|
|
||
| <properties> | ||
| <apm-agent-parent.base.dir>${project.basedir}/../..</apm-agent-parent.base.dir> | ||
| </properties> | ||
|
|
||
| <build> | ||
| <sourceDirectory>src/main/scala</sourceDirectory> | ||
| <testSourceDirectory>src/test/scala</testSourceDirectory> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>net.alchim31.maven</groupId> | ||
| <artifactId>scala-maven-plugin</artifactId> | ||
| <version>4.3.0</version> | ||
| <configuration> | ||
| <scalaVersion>2.12.10</scalaVersion> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| </project> | ||
41 changes: 41 additions & 0 deletions
41
...current-plugin/src/main/scala/co/elastic/apm/agent/concurrent/FutureInstrumentation.scala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package co.elastic.apm.agent.concurrent | ||
|
|
||
| import java.util | ||
|
|
||
| import co.elastic.apm.agent.bci.ElasticApmInstrumentation | ||
| import net.bytebuddy.asm.Advice | ||
| import net.bytebuddy.description.`type`.TypeDescription | ||
| import net.bytebuddy.description.method.MethodDescription | ||
| import net.bytebuddy.matcher.ElementMatcher | ||
| import net.bytebuddy.matcher.ElementMatchers._ | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
| import scala.util.Try | ||
|
|
||
| class FutureInstrumentation extends ElasticApmInstrumentation { | ||
|
|
||
| override def getTypeMatcher: ElementMatcher[_ >: TypeDescription] = | ||
| hasSuperType[TypeDescription](named("scala.concurrent.Future")) | ||
| .or(hasSuperType(named("scala.concurrent.impl.Promise"))) | ||
| .or(hasSuperType(named("scala.concurrent.impl.Promise$Transformation"))) | ||
| .or(hasSuperType(named("scala.concurrent.Future$"))) | ||
|
|
||
| override def getMethodMatcher: ElementMatcher[_ >: MethodDescription] = | ||
| named[MethodDescription]("onComplete").and(returns(classOf[Unit])).and(takesArguments(classOf[Try[_] => _])) | ||
|
milanvdm marked this conversation as resolved.
Outdated
|
||
| // .or(named[MethodDescription]("transform").and(returns(classOf[Future[_]])).and(takesArguments(classOf[Try[_] => Try[_]]))) | ||
| // .or(named[MethodDescription]("transformWith").and(returns(classOf[Future[_]])).and(takesArguments(classOf[Try[_] => Future[_]]))) | ||
| .and(not(isTypeInitializer[MethodDescription]())) | ||
|
|
||
| override def getInstrumentationGroupNames: util.Collection[String] = List("concurrent", "future").asJavaCollection | ||
|
|
||
| @Advice.OnMethodEnter(suppress = classOf[Throwable]) | ||
| def onComplete(@Advice.Argument(value = 0, readOnly = true) callback: Try[_] => _): Unit = { | ||
|
milanvdm marked this conversation as resolved.
Outdated
|
||
| val active = ElasticApmInstrumentation.getActive | ||
| val tracer = ElasticApmInstrumentation.tracer | ||
| if (active != null && tracer != null && tracer.isWrappingAllowedOnThread) { | ||
| active.setDiscard(false) | ||
| tracer.avoidWrappingOnThread() | ||
| } | ||
| } | ||
|
|
||
| } | ||
64 changes: 64 additions & 0 deletions
64
...ent-plugin/src/test/scala/co/elastic/apm/agent/concurrent/FutureInstrumentationSpec.scala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| package co.elastic.apm.agent.concurrent | ||
|
|
||
| import java.util.concurrent.Executors | ||
|
|
||
| import co.elastic.apm.agent.AbstractInstrumentationTest | ||
| import org.assertj.core.api.Assertions.assertThat | ||
| import org.junit.jupiter.api.Test | ||
|
|
||
| import scala.concurrent.duration._ | ||
| import scala.concurrent.{Await, ExecutionContext, Future} | ||
|
|
||
| class FutureInstrumentationSpec extends AbstractInstrumentationTest { | ||
|
|
||
| @Test | ||
| def testWithDefaultConfig(): Unit = { | ||
| new TestFutureTraceMethods().invokeAsync() | ||
| assertThat(AbstractInstrumentationTest.reporter.getTransactions().toArray).hasSize(1) | ||
| assertThat(AbstractInstrumentationTest.reporter.getSpans().toArray).hasSize(4) | ||
| } | ||
|
|
||
| private class TestFutureTraceMethods { | ||
|
|
||
| /** | ||
| * Calling this method results in this method call tree: | ||
| * | ||
| * main thread | worker thread | ||
| * ------------------------------------------------------------------------------------------- | ||
| * invokeAsync | | ||
| * | | | ||
| * --- blockingMethodOnMainThread | | ||
| * | | | ||
| * --- nonBlockingMethodOnMainThread | | ||
| * | | | ||
| * --------------------------> methodOnWorkerThread | ||
| * | | | ||
| * | --- longMethod | ||
| * | | ||
| */ | ||
| def invokeAsync(): Unit = blockingMethodOnMainThread() | ||
|
|
||
| private def blockingMethodOnMainThread(): Unit = { | ||
| try { | ||
| Await.result(nonBlockingMethodOnMainThread(), 10.seconds) | ||
| } catch { | ||
| case e: Exception => e.printStackTrace() | ||
| } | ||
| } | ||
|
|
||
| private def nonBlockingMethodOnMainThread(): Future[Unit] = | ||
| Future(methodOnWorkerThread())(ExecutionContext.fromExecutor(Executors.newFixedThreadPool(1))) | ||
|
felixbarny marked this conversation as resolved.
Outdated
|
||
|
|
||
| private def methodOnWorkerThread(): Unit = longMethod() | ||
|
|
||
| private def longMethod(): Unit = { | ||
| try { | ||
| Thread.sleep(100) | ||
| } catch { | ||
| case e: InterruptedException => e.printStackTrace() | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.