Skip to content

Commit

Permalink
[APM] Agent remote configuration: general settings descriptions (#62276)
Browse files Browse the repository at this point in the history
* Updates general remote config descriptions

I removed `log_level` from here because it seems it doesn't fit at least the Java, Go and Node agents - see #61821, and it is already deactivated for most others (this doesn't have to be included in this PR though).

* Update general_settings.ts

* Restore log_level definition

* Remove extra spaces

Co-authored-by: Nathan L Smith <smith@nlsmith.com>
  • Loading branch information
eyalkoren and smith committed Apr 8, 2020
1 parent d94d7cc commit 1af82c7
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export const generalSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.captureBody.description',
{
defaultMessage:
'For transactions that are HTTP requests, the agent can optionally capture the request body (e.g. POST variables).'
'For transactions that are HTTP requests, the agent can optionally capture the request body (e.g. POST variables).\nFor transactions that are initiated by receiving a message from a message broker, the agent can capture the textual message body.'
}
),
options: [
Expand All @@ -87,7 +87,7 @@ export const generalSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.captureHeaders.description',
{
defaultMessage:
'If set to `true`, the agent will capture request and response headers, including cookies.\n\nNOTE: Setting this to `false` reduces network bandwidth, disk space and object allocations.'
'If set to `true`, the agent will capture HTTP request and response headers (including cookies), as well as message headers/properties when using messaging frameworks (like Kafka).\n\nNOTE: Setting this to `false` reduces network bandwidth, disk space and object allocations.'
}
),
excludeAgents: ['js-base', 'rum-js', 'nodejs']
Expand Down Expand Up @@ -117,7 +117,7 @@ export const generalSettings: RawSettingDefinition[] = [
}),
description: i18n.translate('xpack.apm.agentConfig.recording.description', {
defaultMessage:
'When recording, the agent instruments incoming HTTP requests, tracks errors, and collects and sends metrics. When inactive, the agent works as a noop, not collecting data and not communicating with the APM Server except for polling for updated configuration. As this is a reversible switch, agent threads are not being killed when inactivated, but they will be mostly idle in this state, so the overhead should be negligible. You can use this setting to dynamically control whether Elastic APM is enabled or disabled.'
'When recording, the agent instruments incoming HTTP requests, tracks errors, and collects and sends metrics. When set to non-recording, the agent works as a noop, not collecting data and not communicating with the APM Server except for polling for updated configuration. As this is a reversible switch, agent threads are not being killed when set to non-recording, but they will be mostly idle in this state, so the overhead should be negligible. You can use this setting to dynamically control whether Elastic APM is enabled or disabled.'
}),
excludeAgents: ['nodejs']
},
Expand Down Expand Up @@ -215,7 +215,7 @@ export const generalSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.transactionSampleRate.description',
{
defaultMessage:
'By default, the agent will sample every transaction (e.g. request to your service). To reduce overhead and storage requirements, you can set the sample rate to a value between 0.0 and 1.0. We still record overall time and the result for unsampled transactions, but no context information, labels, or spans.'
'By default, the agent will sample every transaction (e.g. request to your service). To reduce overhead and storage requirements, you can set the sample rate to a value between 0.0 and 1.0. We still record overall time and the result for unsampled transactions, but not context information, labels, or spans.'
}
)
}
Expand Down

0 comments on commit 1af82c7

Please sign in to comment.