kibana/docs/apm/agent-configuration.asciidoc
Bryce Buchanan ff58872368
Added sessionSampleRate to agent configs (#159061)
## Summary

Adds a Mobile specific setting, `SessionSampleRate`. This dictates the
sample rate of all signals (spans, metrics, & logs) on a per-session
basis.

### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-06-13 07:30:56 -07:00

56 lines
2.5 KiB
Text

[role="xpack"]
[[agent-configuration]]
=== APM Agent central configuration
++++
<titleabbrev>Configure APM agents with central config</titleabbrev>
++++
APM Agent configuration allows you to fine-tune your APM agent configuration from within the APM app.
Changes are automatically propagated to your APM agents, so there's no need to redeploy.
To get started, choose the services and environments you wish to configure.
The APM app will let you know when your APM agents have applied your configurations.
[role="screenshot"]
image::apm/images/apm-agent-configuration.png[APM Agent configuration in Kibana]
[float]
==== Precedence
Configurations set from the APM app take precedence over configurations set locally in each APM agent.
However, if APM Server is slow to respond, is offline, reports an error, etc.,
APM agents will use local defaults until they're able to update the configuration.
For this reason, it is still essential to set custom default configurations locally in each of your APM agents.
[float]
==== Supported configurations
Each APM agent has a list of supported configurations.
After selecting a Service name and environment in the APM app,
a list of all supported configuration options,
including descriptions and default values, will be displayed.
Supported configurations are also tagged with the image:./images/dynamic-config.svg[] badge in each APM agent's configuration reference:
[horizontal]
Android agent:: {apm-android-ref}/configuration.html[Configuration reference]
Go agent:: {apm-go-ref}/configuration.html[Configuration reference]
iOS agent:: {apm-ios-ref}/configuration.html[Configuration reference]
Java agent:: {apm-java-ref}/configuration.html[Configuration reference]
.NET agent:: {apm-dotnet-ref}/configuration.html[Configuration reference]
Node.js agent:: {apm-node-ref}/configuration.html[Configuration reference]
PHP agent:: {apm-php-ref}/configuration.html[Configuration reference]
Python agent:: {apm-py-ref}/configuration.html[Configuration reference]
Ruby agent:: {apm-ruby-ref}/configuration.html[Configuration reference]
Real User Monitoring (RUM) agent:: {apm-rum-ref}/configuration.html[Configuration reference]
[float]
==== APM Server configuration
For most users, APM agent configuration should work out-of-the-box.
If you run into trouble, it may be because you're not using the {es} output,
or because your {es} credentials don't have sufficient privileges.
See {apm-guide-ref}/configure-agent-config.html[configure APM agent configuration]
to learn how to configure APM Server to avoid these problems.