Upgrade a self-installation of APM Server standalone to 7.17.20edit

This upgrade guide is for the standalone (legacy) method of running APM Server. Only use this guide if both of the following are true:

  • You have a self-installation of the Elastic Stack, i.e. you’re not using Elastic Cloud.
  • You’re running the APM Server binary, i.e. you haven’t switched to the Elastic APM integration.

Prerequisitesedit

Review the APM release notes, breaking changes, and Observability What’s new content.

Upgrade stepsedit

  1. Upgrade the Elastic Stack to version 7.17.20

    The Elastic Stack (Elasticsearch and Kibana) must be upgraded before APM Server. See the Elastic Stack Installation and Upgrade Guide for guidance.

  2. Install the 7.17.20 APM Server release

    See install to find the command that works with your system.

  3. Review your configuration file

    Some settings may have been removed or changed, so you may need to update your apm-server.yml configuration file prior to starting the APM Server. See Directory layout for help in locating this file, and Configure for a list of all available configuration options.

  4. (Optional) Update custom index patterns and dashboards

    If you set up custom index patterns or dashboards, rerun the setup command to update your new installation of APM Server.

    ./apm-server setup
  5. Start the APM Server

    When you start the APM Server after upgrading, it creates new indices that use the current version, and applies the correct index template automatically. To start the APM Server, run:

    ./apm-server -e

    Additional details are available in start the APM Server.

  6. (Optional) Upgrade to the APM integration

    Got time for one more upgrade? See Switch to the Elastic APM integration.