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.
« Switch to the Elastic APM integration Switch an Elastic Cloud cluster to the APM integration »
Elastic Docs ›Elastic Observability [master] ›Application and service monitoring ›Application performance monitoring (APM) ›Upgrade ›Switch to the Elastic APM integration

Switch a self-installation to the APM integration

edit
Switch a self-installation to the APM integration
edit
  1. Upgrade the Elastic Stack
  2. Add a Fleet Server
  3. Install a Fleet-managed Elastic Agent
  4. Add the APM integration
  5. Stop the APM Server
Upgrade the Elastic Stack
edit

The Elastic Stack (Elasticsearch and Kibana) must be upgraded to version 7.14 or higher. See the Elastic Stack Installation and Upgrade Guide for guidance.

Review the APM release notes, breaking changes, and Observability What’s new content for important changes between your current APM version and this one.

Add a Fleet Server
edit

Fleet Server is a component of the Elastic Stack used to centrally manage Elastic Agents. The APM integration requires a Fleet Server to be running and accessible to your hosts. Add a Fleet Server by following this guide.

If you’re upgrading a self-managed deployment of the Elastic Stack, you’ll need to enable Elasticsearch security and the API key service.

After adding your Fleet Server host and generating a service token, the in-product help in Kibana will provide a command to run to start an Elastic Agent as a Fleet Server. Commands may require administrator privileges.

Verify Fleet Server is running by navigating to Fleet > Agents in Kibana.

Install a Fleet-managed Elastic Agent
edit

It’s possible to install the Elastic APM integration on the same Elastic Agent that is running the Fleet Server integration. For this use case, skip this step.

The Fleet-managed Elastic Agent will run the Elastic APM integration on your edge nodes, next to your applications. To install a Fleet-managed Elastic Agent, follow this guide.

Add the APM integration
edit

The APM integration receives performance data from your APM agents, validates and processes it, and then transforms the data into Elasticsearch documents.

To add the APM integration, see Step 2: Add and configure the APM integration. Only complete the linked step (not the entire quick start guide). If you’re adding the APM integration to a Fleet-managed Elastic Agent, you can use the default policy. If you’re adding the APM integration to the Fleet Server, use the policy that the Fleet Server is running on.

You’ll configure the APM integration in this step. See Configure APM Server for a reference of all available settings. As long as the APM integration is configured with the same secret token or you have API keys enabled on the same host, no reconfiguration is required in your APM agents.

Stop the APM Server
edit

Once data from upgraded APM agents is visible in the Applications UI, it’s safe to stop the APM Server process.

Congratulations — you now have the latest and greatest in Elastic APM!

« Switch to the Elastic APM integration Switch an Elastic Cloud cluster to the APM integration »