Type to search.

API reference

Serverless Unavailable

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Unavailable

    This functionality is not available in Elastic Cloud Serverless.

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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 calling the init method the agent either via script element on the page or require the elastic-apm-rum module in Node.js. The Agent 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().