This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Custom spans Agent API »
Elastic Docs ›

API Reference

edit

API Reference

edit

The API reference documentation is divided into three parts:

  • The Agent API - All functions and properties on the Agent object. An instance of the Agent object is acquired by requiring/importing the Node.js APM Agent module. The Agent is a singleton and the instance is usually referred to by the variable apm in this documentation
  • The Transaction API - All functions and properties on the Transaction object. An instance of the Transaction object is acquired by calling apm.startTransaction()
  • The Span API - All functions and properties on the Span object. An instance of the Span object is acquired by calling apm.startSpan()
« Custom spans Agent API »