Document Opentelemetry dependencies - #1240
Open
pjfanning wants to merge 2 commits into
Open
Conversation
Added note about Opentelemetry Java Instrumentation dependency in startPoolInterface method.
pjfanning
changed the title
pjfanning
added a commit
to apache/pekko
that referenced
this pull request
Aug 28, 2026
…ents (#3473) Motivation: The OpenTelemetry Java agent propagates trace context through pekko actors, streams and remoting by attaching bytecode advice to specific internal methods. Its muzzle checks verify the classes the advice code calls, not the method matchers, so renaming, inlining or restructuring a matched method silently stops context propagation with no error and no log. Modification: Document the matched methods where they are declared, naming the agent, saying what it uses the method for and linking to the instrumentation source. Mark them `@noinline` so the compiler cannot inline them out of the bytecode. List the RemoteInstrument identifiers known to be taken by other projects so that the next implementer can pick a free one. No API changes. Result: The load-bearing internal APIs are recorded next to the code, and new InstrumentationPointsSpec suites fail loudly if a matched name, arity or parameter type disappears from the bytecode. Tests: - sbt "actor-tests/testOnly org.apache.pekko.dispatch.InstrumentationPointsSpec" - 6 passed - sbt "stream-tests/testOnly org.apache.pekko.stream.impl.fusing.InstrumentationPointsSpec" - 1 passed - sbt "remote/testOnly org.apache.pekko.remote.InstrumentationPointsSpec" - 10 passed - sbt actor/mimaReportBinaryIssues stream/mimaReportBinaryIssues remote/mimaReportBinaryIssues - clean - sbt scalafmtCheckAll scalafmtSbtCheck - pass - sbt headerCreateAll - headers added for the three new files References: Fixes #3472, Refs apache/pekko-http#1240, Refs open-telemetry/opentelemetry-java-instrumentation#19823
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Added note about Opentelemetry Java Instrumentation dependency in startPoolInterface method and elsewhere.
part of #1241