IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Agent Configuration APIedit
The Agent configuration API allows you to fine-tune your APM agent configuration, without needing to redeploy your application.
The following Agent configuration APIs are available:
- Create or update configuration to create or update an Agent configuration
- Delete configuration to delete an Agent configuration.
- List configuration to list all Agent configurations.
- Search configuration to search for an Agent configuration.
Create or update configurationedit
Requestedit
PUT /api/apm/settings/agent-configuration
Request bodyedit
-
service
-
(required, object) Service identifying the configuration to create or update.
Properties of
service
-
name
- (required, string) Name of service
-
environment
- (optional, string) Environment of service
-
-
settings
- (required) Key/value object with option name and option value.
-
agent_name
- (optional) The agent name is used by the UI to determine which settings to display.
Exampleedit
PUT /api/apm/settings/agent-configuration { "service": { "name": "frontend", "environment": "production" }, "settings": { "transaction_sample_rate": "0.4", "capture_body": "off", "transaction_max_spans": "500" }, "agent_name": "nodejs" }
Delete configurationedit
Requestedit
DELETE /api/apm/settings/agent-configuration
Request bodyedit
-
service
-
(required, object) Service identifying the configuration to delete
Properties of
service
-
name
- (required, string) Name of service
-
environment
- (optional, string) Environment of service
-
Exampleedit
DELETE /api/apm/settings/agent-configuration { "service" : { "name": "frontend", "environment": "production" } }
List configurationedit
Requestedit
GET /api/apm/settings/agent-configuration
Response bodyedit
[ { "agent_name": "go", "service": { "name": "opbeans-go", "environment": "production" }, "settings": { "transaction_sample_rate": "1", "capture_body": "off", "transaction_max_spans": "200" }, "@timestamp": 1581934104843, "applied_by_agent": false, "etag": "1e58c178efeebae15c25c539da740d21dee422fc" }, { "agent_name": "go", "service": { "name": "opbeans-go" }, "settings": { "transaction_sample_rate": "1", "capture_body": "off", "transaction_max_spans": "300" }, "@timestamp": 1581934111727, "applied_by_agent": false, "etag": "3eed916d3db434d9fb7f039daa681c7a04539a64" }, { "agent_name": "nodejs", "service": { "name": "frontend" }, "settings": { "transaction_sample_rate": "1", }, "@timestamp": 1582031336265, "applied_by_agent": false, "etag": "5080ed25785b7b19f32713681e79f46996801a5b" } ]
Exampleedit
GET /api/apm/settings/agent-configuration
Search configurationedit
Requestedit
POST /api/apm/settings/agent-configuration/search
Request bodyedit
-
service
-
(required, object) Service identifying the configuration.
Properties of
service
-
name
- (required, string) Name of service
-
environment
- (optional, string) Environment of service
-
-
etag
-
(required) etag is sent by the agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its
applied_by_agent
property will be set totrue
. Every time a configuration is editedapplied_by_agent
is reset tofalse
.
Response bodyedit
{ "_index": ".apm-agent-configuration", "_id": "CIaqXXABmQCdPphWj8EJ", "_score": 2, "_source": { "agent_name": "nodejs", "service": { "name": "frontend" }, "settings": { "transaction_sample_rate": "1", }, "@timestamp": 1582031336265, "applied_by_agent": false, "etag": "5080ed25785b7b19f32713681e79f46996801a5b" } }
Exampleedit
POST /api/apm/settings/agent-configuration/search { "etag": "1e58c178efeebae15c25c539da740d21dee422fc", "service" : { "name": "frontend", "environment": "production" } }