Skip to content

Commit

Permalink
Merge branch 'main' into issue-4312
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis authored Jan 3, 2025
2 parents e890cb8 + fc96ea1 commit 2140737
Show file tree
Hide file tree
Showing 17 changed files with 237 additions and 247 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/elastic-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,8 @@ body:
description: Some requests may be tied to the Elastic Stack release schedule. Some, like Serverless requests, may not. Please select an option.
options:
- 'N/A'
- '8.15'
- '8.16'
- '8.17'
- '8.18'
- '9.0'
- '9.1'
- '9.2'
Expand Down
36 changes: 19 additions & 17 deletions docs/en/observability/apm/configure/agent-config.asciidoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
[[apm-configure-agent-config]]
= Configure APM agent configuration
= Configure APM agent central configuration

++++
<titleabbrev>APM agent configuration</titleabbrev>
<titleabbrev>APM agent central configuration</titleabbrev>
++++

****
image:./binary-yes-fm-yes.svg[supported deployment methods]
APM agent configuration is supported by all APM Server deployment methods.
APM agent central configuration is supported by all APM Server deployment methods,
but some options are only supported for APM Server binary users.
****

APM agent configuration allows you to fine-tune your APM agents from within the Applications UI.
APM agent central configuration allows you to fine-tune your APM agents from within the Applications UI.
Changes are automatically propagated to your APM agents, so there's no need to redeploy your applications.

To learn more about this feature, see <<apm-agent-configuration,APM agent configuration>>.
To learn more about this feature, see <<apm-agent-configuration,APM agent central configuration>>.

Here's a sample configuration:
[float]
== APM agent configuration options

*The following options are only supported for APM Server binary users*.

You can specify APM agent configuration options in the `apm-server.agent.config` section of the
`apm-server.yml` config file. Here's a sample configuration:

[source,yaml]
----
Expand All @@ -26,18 +33,11 @@ apm-server.agent.config.elasticsearch.api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSo
<1> {blank}
include::./outputs/elasticsearch.asciidoc[tag=configure-beats]

[float]
== APM agent configuration options

The following options are only supported for APM Server binary users.
You can specify these options in the `apm-server.agent.config` section of the
+apm-server.yml+ config file:

[float]
[[apm-agent-config-cache]]
=== `apm-server.agent.config.cache.expiration`

When using APM agent configuration, information fetched from {es} will be cached in memory for some time.
When using APM agent central configuration, information fetched from {es} will be cached in memory for some time.
Specify the cache expiration time via this setting. Defaults to `30s` (30 seconds).

[float]
Expand All @@ -47,7 +47,7 @@ Specify the cache expiration time via this setting. Defaults to `30s` (30 second
Takes the same options as <<apm-elasticsearch-output,output.elasticsearch>>.

For APM Server binary users and Elastic Agent standalone-managed APM Server,
APM agent configuration is automatically fetched from {es} using the `output.elasticsearch`
APM agent central configuration is automatically fetched from {es} using the `output.elasticsearch`
configuration. If `output.elasticsearch` isn't set or doesn't have sufficient privileges,
use these {es} options to provide {es} access.

Expand All @@ -57,7 +57,8 @@ use these {es} options to provide {es} access.
[float]
==== HTTP 403 errors

You may see either of the following HTTP 403 errors from APM Server when it attempts to fetch APM agent configuration:
You may see either of the following HTTP 403 errors from APM Server when it attempts to fetch
the APM agent central configuration:

APM agent log:

Expand All @@ -76,7 +77,8 @@ rejecting fetch request: no valid elasticsearch config
This occurs because the user or API key set in either `apm-server.agent.config.elasticsearch` or `output.elasticsearch`
(if `apm-server.agent.config.elasticsearch` is not set) does not have adequate permissions to read source maps from {es}.

To fix this error, ensure that APM Server has all the required privileges. See <<apm-privileges-agent-central-config-server>> for more details.
To fix this error, ensure that APM Server has all the required privileges. For more details, refer to
<<apm-privileges-agent-central-config-server,Create a _central configuration management_ role>>.

[float]
==== HTTP 401 errors
Expand Down
39 changes: 1 addition & 38 deletions docs/en/observability/apm/configure/rum.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,45 +162,8 @@ Search source maps stored in an older version with this setting.

Default: `"apm-*-sourcemap*"`

[float]
[[apm-rum-deprecated]]
== Deprecated configuration options

[float]
[[apm-event_rate.limit]]
=== `event_rate.limit`

deprecated::[7.15.0, Replaced by <<apm-config-auth-anon-event-limit>>.]

The maximum number of events allowed per second, per agent IP address.

Default: `300`

[float]
=== `event_rate.lru_size`

deprecated::[7.15.0, Replaced by <<apm-config-auth-anon-ip-limit>>.]

The number of unique IP addresses to track in an LRU cache.
IP addresses in the cache will be rate limited according to the <<apm-config-auth-anon-event-limit>> setting.
Consider increasing this default if your site has many concurrent clients.

Default: `1000`

[float]
[[apm-rum-allow-service-names]]
=== `allow_service_names`

deprecated::[7.15.0, Replaced by <<apm-config-auth-anon-allow-service>>.]
A list of permitted service names for RUM support.
Names in this list must match the agent's `service.name`.
This can be set to restrict RUM events to those with one of a set of known service names,
in order to limit the number of service-specific indices or data streams created.

Default: Not set (any service name is accepted)

[float]
== Ingest pipelines

The default APM Server pipeline includes processors that enrich RUM data prior to indexing in {es}.
See <<apm-ingest-pipelines>> for details on how to locate, edit, or disable this preprocessing.
See <<apm-ingest-pipelines>> for details on how to locate, edit, or disable this preprocessing.
Loading

0 comments on commit 2140737

Please sign in to comment.