Add APM user settings

Elastic Cloud Enterprise supports most of the APM settings. Through a YAML editor in the console, you can append your APM Server properties to the apm-server.yml file. Your changes to the configuration file are read on startup.

Important

Be aware that some settings could break your cluster if set incorrectly and that the syntax might change between major versions. Before upgrading, be sure to review the full list of the latest APM settings and syntax.

To change APM settings:

  1. Log into the Cloud UI.
  2. On the Deployments page, select your deployment.

    Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

  3. From your deployment menu, go to the Edit page.
  4. At the bottom of the APM section, expand the User setting overrides caret.
  5. Update the user settings.
  6. Click Save changes.
Note

If a setting is not supported by Elastic Cloud Enterprise, you get an error message when you try to save. We suggest changing one setting with each save, so you know which one is not supported.

Example: Enable RUM and increase the rate limit

When capturing the user interaction with clients with real user monitoring (RUM), particularly for situations with concurrent clients, you can increase the number of times each IP address can send a request to the RUM endpoint. Version 6.5 includes an additional settings for the LRU cache.

For APM Server version 6.5 and later with RUM agent version 2.x or 3.x:

apm-server:
  rum:
    enabled: true
    event rate:
      limit: 3000
      lru_size: 5000
Note

With the version 6.5 release, we recommend verifying that your agents continue to be compatible with your APM Server.

For APM Server version 6.4 or 6.3 with RUM agent version 0.x or 1.x:

apm-server:
  rum:
    enabled: true
    rate_limit: 100

Example: Disable RUM

If you know that you won’t be tracking RUM data, you can disable the endpoint proactively.

For APM Server version 6.4 and later:

apm-server:
  rum:
    enabled: false

Example: Adjust the event limits configuration

If the size of the HTTP request frequently exceeds the maximum, you might need to change the limit on the APM Server and adjust the relevant settings in the agent.

For APM Server version 6.5 and later:

apm-server:
  max_event_size: 407200