opentelemetry-java-instrume.../instrumentation-core
Anuraag Agrawal d8355c672d
Docs for writing new instrumentation... (#652)
* Docs for writing new instrumentation
2020-07-19 14:21:19 +09:00
..
apache-httpclient-4.0 Remove Lombok (#672) 2020-07-18 15:52:55 +03:00
reactor-3.1 Docs for writing new instrumentation... (#652) 2020-07-19 14:21:19 +09:00
servlet Remove Lombok (#672) 2020-07-18 15:52:55 +03:00
spring Add spring-autoconfigure project (#661) 2020-07-17 22:36:58 -07:00
README.md Shade AWS instrumentation library when using in agent (#644) 2020-07-08 12:36:55 +09:00

README.md

Instrumentation Core

These modules for the core logic for library instrumentation. instrumentation should add core logic here which can be set up manually by a user, and agent-specific code for automatically setting up the instrumentation in that folder.

Note, we are currently working on separating instrumentatin projects so that their core parts can be accessed by users not using the agent. Due to the current Gradle setup, we have these two top-level folders, instrumentation and instrumentation-core, but eventually we want to move to flattening them into something like

instrumentation/
  aws-sdk-2.2/
    aws-sdk-2.2/
    aws-sdk-2.2-auto/

Shading core instrumentation

The instrumentation in this folder is intended for use both directly from user apps and from the agent when it automatically adds instrumentation to a user app. This means that the same library may be used both by the agent and the app at the same time, so to prevent any conflicts, we make sure to use a shaded version from the agent, which is not published for use from users, e.g.,

shadowJar {
  archiveClassifier = 'agent'

  configurations = []

  relocate 'io.opentelemetry.instrumentation.awssdk.v2_2', 'io.opentelemetry.auto.instrumentation.awssdk.v2_2.shaded'
}