IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Advanced Setup and Configuration Agent API »
Elastic Docs ›

API Reference

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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()
« Advanced Setup and Configuration Agent API »