Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] APM Agent config: Option values must be string #65875

Merged
merged 2 commits into from
May 11, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/apm/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following Agent configuration APIs are available:
======

`settings`::
(required) Key/value object with settings and their corresponding value.
(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.
Expand All @@ -73,14 +73,14 @@ The following Agent configuration APIs are available:
--------------------------------------------------
PUT /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"environment" : "production"
"service": {
"name": "frontend",
"environment": "production"
},
"settings" : {
"transaction_sample_rate" : 0.4,
"capture_body" : "off",
"transaction_max_spans" : 500
"settings": {
"transaction_sample_rate": "0.4",
"capture_body": "off",
"transaction_max_spans": "500"
},
"agent_name": "nodejs"
}
Expand Down Expand Up @@ -124,7 +124,7 @@ PUT /api/apm/settings/agent-configuration
DELETE /api/apm/settings/agent-configuration
{
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down Expand Up @@ -157,9 +157,9 @@ DELETE /api/apm/settings/agent-configuration
"environment": "production"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 200
"transaction_max_spans": "200"
},
"@timestamp": 1581934104843,
"applied_by_agent": false,
Expand All @@ -171,9 +171,9 @@ DELETE /api/apm/settings/agent-configuration
"name": "opbeans-go"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
"capture_body": "off",
"transaction_max_spans": 300
"transaction_max_spans": "300"
},
"@timestamp": 1581934111727,
"applied_by_agent": false,
Expand All @@ -185,7 +185,7 @@ DELETE /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand Down Expand Up @@ -250,7 +250,7 @@ GET /api/apm/settings/agent-configuration
"name": "frontend"
},
"settings": {
"transaction_sample_rate": 1,
"transaction_sample_rate": "1",
},
"@timestamp": 1582031336265,
"applied_by_agent": false,
Expand All @@ -266,9 +266,9 @@ GET /api/apm/settings/agent-configuration
--------------------------------------------------
POST /api/apm/settings/agent-configuration/search
{
"etag" : "1e58c178efeebae15c25c539da740d21dee422fc",
"etag": "1e58c178efeebae15c25c539da740d21dee422fc",
"service" : {
"name" : "frontend",
"name": "frontend",
"environment": "production"
}
}
Expand Down