- Legacy APM Server Reference:
- Overview
- Getting Started With APM Server
- Setting up APM Server
- Upgrading APM Server
- Configuring APM Server
- General configuration options
- Configure the output
- Parse data using ingest node pipelines
- SSL/TLS settings
- Load the Elasticsearch index template
- Index lifecycle management (ILM)
- Configure logging
- Configure the Kibana endpoint
- Set up Real User Monitoring (RUM) support
- Use environment variables in the configuration
- Configure project paths
- Securing APM Server
- Monitoring APM Server
- Real User Monitoring (RUM)
- Tune Data Ingestion
- Storage Management
- Intake API
- Exploring data in Elasticsearch
- Exported fields
- Troubleshooting
- Release notes
A newer version is available. For the latest information, see the
current release documentation.
Agent configuration APIedit
APM Server exposes an API endpoint that allows agents to query the server for configuration changes. More information on this feature is available in APM Agent configuration in Kibana.
Agent configuration endpointedit
Send an HTTP GET
request to the agent configuration endpoint.
service.name
is a required query string parameter.
http(s)://{hostname}:{port}/config/v1/agents?service.name=SERVICE_NAME
If a secret_token
has been configured, it should also apply to this endpoint.
Responsesedit
-
Successful -
200
-
Kibana endpoint is disabled -
403
-
Kibana is unreachable -
503
Exampleedit
Example Agent configuration request including the service name "test-service":
curl -i http://127.0.0.1:8200/config/v1/agents?service.name=test-service
A sample response to the above curl request:
HTTP/1.1 200 OK Cache-Control: max-age=30, must-revalidate Content-Type: application/json Etag: "5" Date: Fri, 05 Jul 2019 21:47:35 GMT Content-Length: 30 { "sampling_rate": "0.12" }
On this page
Was this helpful?
Thank you for your feedback.