Skip to content

Commit

Permalink
[APM] Update central configuration text (#61556)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bmorelli25
bmorelli25 authored Apr 1, 2020
1 parent 687b562 commit e4ee030
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions x-pack/plugins/apm/common/agent_configuration/setting_definitions/general_settings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,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). Default is "off".'
'For transactions that are HTTP requests, the agent can optionally capture the request body (e.g. POST variables).'
}
),
options: [
Expand Down Expand Up @@ -191,7 +191,7 @@ export const generalSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.transactionMaxSpans.description',
{
defaultMessage:
'Limits the amount of spans that are recorded per transaction. Default is 500.'
'Limits the amount of spans that are recorded per transaction.'
}
),
min: 0,
Expand Down
24 changes: 12 additions & 12 deletions x-pack/plugins/apm/common/agent_configuration/setting_definitions/java_settings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.enableLogCorrelation.description',
{
defaultMessage:
"A boolean specifying if the agent should integrate into SLF4J's https://www.slf4j.org/api/org/slf4j/MDC.html[MDC] to enable trace-log correlation.\nIf set to `true`, the agent will set the `trace.id` and `transaction.id` for the currently active spans and transactions to the MDC.\nSee <<log-correlation>> for more details.\n\nNOTE: While it's allowed to enable this setting at runtime, you can't disable it without a restart."
"A boolean specifying if the agent should integrate into SLF4J's MDC to enable trace-log correlation. If set to `true`, the agent will set the `trace.id` and `transaction.id` for the currently active spans and transactions to the MDC. While it's allowed to enable this setting at runtime, you can't disable it without a restart."
}
),
includeAgents: ['java']
Expand Down Expand Up @@ -61,7 +61,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.circuitBreakerEnabled.description',
{
defaultMessage:
'A boolean specifying whether the circuit breaker should be enabled or not. \nWhen enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. \nIf ANY of the monitors detects a stress indication, the agent will become inactive, as if the \n<<config-active>> configuration option has been set to `false`, thus reducing resource consumption to a minimum. \nWhen inactive, the agent continues polling the same monitors in order to detect whether the stress state \nhas been relieved. If ALL monitors approve that the system/process/JVM is not under stress anymore, the \nagent will resume and become fully functional.'
'A boolean specifying whether the circuit breaker should be enabled or not. When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. If ANY of the monitors detects a stress indication, the agent will become inactive, as if the `active` configuration option has been set to `false`, thus reducing resource consumption to a minimum. When inactive, the agent continues polling the same monitors in order to detect whether the stress state has been relieved. If ALL monitors approve that the system/process/JVM is not under stress anymore, the agent will resume and become fully functional.'
}
),
includeAgents: ['java']
Expand All @@ -79,7 +79,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.stressMonitorGcStressThreshold.description',
{
defaultMessage:
'The threshold used by the GC monitor to rely on for identifying heap stress.\nThe same threshold will be used for all heap pools, so that if ANY has a usage percentage that crosses it, \nthe agent will consider it as a heap stress. The GC monitor relies only on memory consumption measured \nafter a recent GC.'
'The threshold used by the GC monitor to rely on for identifying heap stress. The same threshold will be used for all heap pools, so that if ANY has a usage percentage that crosses it, the agent will consider it as a heap stress. The GC monitor relies only on memory consumption measured after a recent GC.'
}
),
includeAgents: ['java']
Expand All @@ -98,7 +98,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.stressMonitorGcReliefThreshold.description',
{
defaultMessage:
'The threshold used by the GC monitor to rely on for identifying when the heap is not under stress .\nIf `stress_monitor_gc_stress_threshold` has been crossed, the agent will consider it a heap-stress state. \nIn order to determine that the stress state is over, percentage of occupied memory in ALL heap pools should \nbe lower than this threshold. The GC monitor relies only on memory consumption measured after a recent GC.'
'The threshold used by the GC monitor to rely on for identifying when the heap is not under stress. If `stress_monitor_gc_stress_threshold` has been crossed, the agent will consider it a heap-stress state. In order to determine that the stress state is over, percentage of occupied memory in ALL heap pools should be lower than this threshold. The GC monitor relies only on memory consumption measured after a recent GC.'
}
),
includeAgents: ['java']
Expand All @@ -116,7 +116,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.stressMonitorCpuDurationThreshold.description',
{
defaultMessage:
'The minimal time required in order to determine whether the system is \neither currently under stress, or that the stress detected previously has been relieved. \nAll measurements during this time must be consistent in comparison to the relevant threshold in \norder to detect a change of stress state. Must be at least `1m`.'
'The minimal time required in order to determine whether the system is either currently under stress, or that the stress detected previously has been relieved. All measurements during this time must be consistent in comparison to the relevant threshold in order to detect a change of stress state. Must be at least `1m`.'
}
),
includeAgents: ['java']
Expand All @@ -134,7 +134,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.stressMonitorSystemCpuStressThreshold.description',
{
defaultMessage:
'The threshold used by the system CPU monitor to detect system CPU stress. \nIf the system CPU crosses this threshold for a duration of at least `stress_monitor_cpu_duration_threshold`, \nthe monitor considers this as a stress state.'
'The threshold used by the system CPU monitor to detect system CPU stress. If the system CPU crosses this threshold for a duration of at least `stress_monitor_cpu_duration_threshold`, the monitor considers this as a stress state.'
}
),
includeAgents: ['java']
Expand All @@ -152,7 +152,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.stressMonitorSystemCpuReliefThreshold.description',
{
defaultMessage:
'The threshold used by the system CPU monitor to determine that the system is \nnot under CPU stress. If the monitor detected a CPU stress, the measured system CPU needs to be below \nthis threshold for a duration of at least `stress_monitor_cpu_duration_threshold` in order for the \nmonitor to decide that the CPU stress has been relieved.'
'The threshold used by the system CPU monitor to determine that the system is not under CPU stress. If the monitor detected a CPU stress, the measured system CPU needs to be below this threshold for a duration of at least `stress_monitor_cpu_duration_threshold` in order for the monitor to decide that the CPU stress has been relieved.'
}
),
includeAgents: ['java']
Expand All @@ -175,7 +175,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.profilingInferredSpansEnabled.description',
{
defaultMessage:
'Set to `true` to make the agent create spans for method executions based on\nhttps://github.com/jvm-profiling-tools/async-profiler[async-profiler], a sampling aka statistical profiler.\n\nDue to the nature of how sampling profilers work,\nthe duration of the inferred spans are not exact, but only estimations.\nThe <<config-profiling-inferred-spans-sampling-interval, `profiling_inferred_spans_sampling_interval`>> lets you fine tune the trade-off between accuracy and overhead.\n\nThe inferred spans are created after a profiling session has ended.\nThis means there is a delay between the regular and the inferred spans being visible in the UI.\n\nNOTE: This feature is not available on Windows'
'Set to `true` to make the agent create spans for method executions based on async-profiler, a sampling aka statistical profiler. Due to the nature of how sampling profilers work, the duration of the inferred spans are not exact, but only estimations. The `profiling_inferred_spans_sampling_interval` lets you fine tune the trade-off between accuracy and overhead. The inferred spans are created after a profiling session has ended. This means there is a delay between the regular and the inferred spans being visible in the UI. This feature is not available on Windows'
}
),
includeAgents: ['java']
Expand All @@ -193,7 +193,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.profilingInferredSpansSamplingInterval.description',
{
defaultMessage:
'The frequency at which stack traces are gathered within a profiling session.\nThe lower you set it, the more accurate the durations will be.\nThis comes at the expense of higher overhead and more spans for potentially irrelevant operations.\nThe minimal duration of a profiling-inferred span is the same as the value of this setting.'
'The frequency at which stack traces are gathered within a profiling session. The lower you set it, the more accurate the durations will be. This comes at the expense of higher overhead and more spans for potentially irrelevant operations. The minimal duration of a profiling-inferred span is the same as the value of this setting.'
}
),
includeAgents: ['java']
Expand All @@ -211,7 +211,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.profilingInferredSpansMinDuration.description',
{
defaultMessage:
'The minimum duration of an inferred span.\nNote that the min duration is also implicitly set by the sampling interval.\nHowever, increasing the sampling interval also decreases the accuracy of the duration of inferred spans.'
'The minimum duration of an inferred span. Note that the min duration is also implicitly set by the sampling interval. However, increasing the sampling interval also decreases the accuracy of the duration of inferred spans.'
}
),
includeAgents: ['java']
Expand All @@ -229,7 +229,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.profilingInferredSpansIncludedClasses.description',
{
defaultMessage:
'If set, the agent will only create inferred spans for methods which match this list.\nSetting a value may slightly increase performance and can reduce clutter by only creating spans for the classes you are interested in.\nExample: `org.example.myapp.*`\n\nThis option supports the wildcard `*`, which matches zero or more characters.\nExamples: `/foo/*/bar/*/baz*`, `*foo*`.\nMatching is case insensitive by default.\nPrepending an element with `(?-i)` makes the matching case sensitive.'
'If set, the agent will only create inferred spans for methods which match this list. Setting a value may slightly increase performance and can reduce clutter by only creating spans for the classes you are interested in. Example: `org.example.myapp.*` This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.'
}
),
includeAgents: ['java']
Expand All @@ -248,7 +248,7 @@ export const javaSettings: RawSettingDefinition[] = [
'xpack.apm.agentConfig.profilingInferredSpansExcludedClasses.description',
{
defaultMessage:
'Excludes classes for which no profiler-inferred spans should be created.\n\nThis option supports the wildcard `*`, which matches zero or more characters.\nExamples: `/foo/*/bar/*/baz*`, `*foo*`.\nMatching is case insensitive by default.\nPrepending an element with `(?-i)` makes the matching case sensitive.'
'Excludes classes for which no profiler-inferred spans should be created. This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.'
}
),
includeAgents: ['java']
Expand Down

0 comments on commit e4ee030

Please sign in to comment.