Skip to content

README.md

Latest commit

 

History

History
23 lines (18 loc) · 1.24 KB

README.md

File metadata and controls

23 lines (18 loc) · 1.24 KB

Agent Plugins

This folder contains agent plugins. A plugin most commonly is an instrumentation for a specific framework or technology. To add a new plugin, follow these steps:

  1. Create a new maven sub-module in apm-agent-plugins
  2. Add the module in the <modules> section of apm-agent-plugins/pom.xml
  3. Add a dependency to your new module in elastic-apm-agent/pom.xml to make sure it is included in the agent jar
  4. If you need to add any new runtime dependencies for the agent, make sure to properly configure shading in elastic-apm-agent/pom.xml
  5. Properly test your module with unit tests and consider adding integration tests. See CONTRIBUTING.md for more guidance.
  6. Add information about the supported technology in docs/intro.asciidoc
  7. Add a line in CHANGELOG.asciidoc

NOTE: when adding advices, make sure to add (suppress = Throwable.class) to the net.bytebuddy.asm.Advice.OnMethodEnter and net.bytebuddy.asm.Advice.OnMethodExit annotations. Search for the regex @.*OnMethod(Enter|Exit)(?!\(s) to find annotations with a missing suppress attribute.