github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add missing options to APM central config (#143668)

Browse source
This commit is contained in:
Felix Barnsteiner 2022-10-25 13:46:55 +02:00 • committed by GitHub
parent c53909f6d8
commit b338633352
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 586 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

14
x-pack/plugins/apm/common/agent_configuration/runtime_types/trace_continuation_strategy_rt.ts Normal file
View file

@ -0,0 +1,14 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import * as t from 'io-ts';
export const traceContinuationStrategyRt = t.union([
t.literal('continue'),
t.literal('restart'),
t.literal('restart_external'),
]);

107
x-pack/plugins/apm/common/agent_configuration/setting_definitions/__snapshots__/index.test.ts.snap generated
View file

@ -47,21 +47,57 @@ Array [
"type": "select",
"validationName": "(\\"off\\" | \\"errors\\" | \\"transactions\\" | \\"all\\")",
},
Object {
"key": "capture_body_content_types",
"type": "text",
"validationName": "string",
},
Object {
"key": "capture_headers",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
Object {
"key": "capture_jmx_metrics",
"type": "text",
"validationName": "string",
},
Object {
"key": "circuit_breaker_enabled",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
Object {
"key": "dedot_custom_metrics",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
Object {
"key": "enable_log_correlation",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
Object {
"key": "exit_span_min_duration",
"min": "0ms",
"type": "duration",
"units": Array [
"ms",
"s",
"m",
],
"validationName": "durationRt",
},
Object {
"key": "ignore_exceptions",
"type": "text",
"validationName": "string",
},
Object {
"key": "ignore_message_queues",
"type": "text",
"validationName": "string",
},
Object {
"key": "log_level",
"options": Array [
@ -156,6 +192,33 @@ Array [
],
"validationName": "durationRt",
},
Object {
"key": "span_compression_enabled",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
Object {
"key": "span_compression_exact_match_max_duration",
"min": "0ms",
"type": "duration",
"units": Array [
"ms",
"s",
"m",
],
"validationName": "durationRt",
},
Object {
"key": "span_compression_same_kind_max_duration",
"min": "0ms",
"type": "duration",
"units": Array [
"ms",
"s",
"m",
],
"validationName": "durationRt",
},
Object {
"key": "span_frames_min_duration",
"min": "-1ms",
@ -205,11 +268,40 @@ Array [
"type": "float",
"validationName": "floatRt",
},
Object {
"key": "trace_continuation_strategy",
"options": Array [
Object {
"text": "continue",
"value": "continue",
},
Object {
"text": "restart",
"value": "restart",
},
Object {
"text": "restart_external",
"value": "restart_external",
},
],
"type": "select",
"validationName": "(\\"continue\\" | \\"restart\\" | \\"restart_external\\")",
},
Object {
"key": "trace_methods",
"type": "text",
"validationName": "string",
},
Object {
"key": "transaction_ignore_urls",
"type": "text",
"validationName": "string",
},
Object {
"key": "transaction_ignore_user_agents",
"type": "text",
"validationName": "string",
},
Object {
"key": "transaction_max_spans",
"max": undefined,
@ -217,10 +309,25 @@ Array [
"type": "integer",
"validationName": "integerRt",
},
Object {
"key": "transaction_name_groups",
"type": "text",
"validationName": "string",
},
Object {
"key": "transaction_sample_rate",
"type": "float",
"validationName": "floatRt",
},
Object {
"key": "unnest_exceptions",
"type": "text",
"validationName": "string",
},
Object {
"key": "use_path_as_transaction_name",
"type": "boolean",
"validationName": "(\\"true\\" | \\"false\\")",
},
]
`;

257
x-pack/plugins/apm/common/agent_configuration/setting_definitions/general_settings.ts
View file

@ -8,6 +8,7 @@
import { i18n } from '@kbn/i18n';
import { captureBodyRt } from '../runtime_types/capture_body_rt';
import { logLevelRt } from '../runtime_types/log_level_rt';
import { traceContinuationStrategyRt } from '../runtime_types/trace_continuation_strategy_rt';
import { RawSettingDefinition } from './types';
export const generalSettings: RawSettingDefinition[] = [
@ -72,6 +73,29 @@ export const generalSettings: RawSettingDefinition[] = [
excludeAgents: ['js-base', 'rum-js', 'php'],
},
{
key: 'capture_body_content_types',
type: 'text',
defaultValue:
'application/x-www-form-urlencoded*, text/*, application/json*, application/xml*',
label: i18n.translate(
'xpack.apm.agentConfig.captureBodyContentTypes.label',
{
defaultMessage: 'Capture Body Content Types',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.captureBodyContentTypes.description',
{
defaultMessage:
'Configures which content types should be recorded.\n' +
'\n' +
'The defaults end with a wildcard so that content types like `text/plain; charset=utf-8` are captured as well.',
}
),
includeAgents: ['java'],
},
// Capture headers
{
key: 'capture_headers',
@ -90,6 +114,67 @@ export const generalSettings: RawSettingDefinition[] = [
excludeAgents: ['js-base', 'rum-js', 'nodejs', 'php'],
},
{
key: 'dedot_custom_metrics',
type: 'boolean',
defaultValue: 'true',
label: i18n.translate('xpack.apm.agentConfig.dedotCustomMetrics.label', {
defaultMessage: 'Dedot custom metrics',
}),
description: i18n.translate(
'xpack.apm.agentConfig.dedotCustomMetrics.description',
{
defaultMessage:
'Replaces dots with underscores in the metric names for custom metrics.\n' +
'\n' +
'WARNING: Setting this to `false` can lead to mapping conflicts as dots indicate nesting in Elasticsearch.\n' +
'An example of when a conflict happens is two metrics with the name `foo` and `foo.bar`.\n' +
'The first metric maps `foo` to a number and the second metric maps `foo` as an object.',
}
),
includeAgents: ['java'],
},
{
key: 'exit_span_min_duration',
type: 'duration',
defaultValue: '0ms',
min: '0ms',
label: i18n.translate('xpack.apm.agentConfig.exitSpanMinDuration.label', {
defaultMessage: 'Exit span min duration',
}),
description: i18n.translate(
'xpack.apm.agentConfig.exitSpanMinDuration.description',
{
defaultMessage:
'Exit spans are spans that represent a call to an external service, like a database. If such calls are very short, they are usually not relevant and can be ignored.\n' +
'\n' +
'NOTE: If a span propagates distributed tracing ids, it will not be ignored, even if it is shorter than the configured threshold. This is to ensure that no broken traces are recorded.',
}
),
includeAgents: ['java'],
},
{
key: 'ignore_message_queues',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.ignoreMessageQueues.label', {
defaultMessage: 'Ignore message queues',
}),
description: i18n.translate(
'xpack.apm.agentConfig.ignoreMessageQueues.description',
{
defaultMessage:
'Used to filter out specific messaging queues/topics from being traced. \n' +
'\n' +
'This property should be set to an array containing one or more strings.\n' +
'When set, sends-to and receives-from the specified queues/topic will be ignored.',
}
),
includeAgents: ['java'],
},
// LOG_LEVEL
{
key: 'log_level',
@ -147,6 +232,68 @@ export const generalSettings: RawSettingDefinition[] = [
includeAgents: ['java'],
},
{
key: 'span_compression_enabled',
type: 'boolean',
defaultValue: 'true',
label: i18n.translate(
'xpack.apm.agentConfig.spanCompressionEnabled.label',
{
defaultMessage: 'Span compression enabled',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.spanCompressionEnabled.description',
{
defaultMessage:
'Setting this option to true will enable span compression feature.\n' +
'Span compression reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that some information such as DB statements of all the compressed spans will not be collected.',
}
),
includeAgents: ['java'],
},
{
key: 'span_compression_exact_match_max_duration',
type: 'duration',
defaultValue: '50ms',
min: '0ms',
label: i18n.translate(
'xpack.apm.agentConfig.spanCompressionExactMatchMaxDuration.label',
{
defaultMessage: 'Span compression exact match max duration',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.spanCompressionExactMatchMaxDuration.description',
{
defaultMessage:
'Consecutive spans that are exact match and that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected.',
}
),
includeAgents: ['java'],
},
{
key: 'span_compression_same_kind_max_duration',
type: 'duration',
defaultValue: '0ms',
min: '0ms',
label: i18n.translate(
'xpack.apm.agentConfig.spanCompressionSameKindMaxDuration.label',
{
defaultMessage: 'Span compression same kind max duration',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.spanCompressionSameKindMaxDuration.description',
{
defaultMessage:
'Consecutive spans to the same destination that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected.',
}
),
includeAgents: ['java'],
},
// SPAN_FRAMES_MIN_DURATION
{
key: 'span_frames_min_duration',
@ -184,6 +331,44 @@ export const generalSettings: RawSettingDefinition[] = [
includeAgents: ['java', 'dotnet', 'go'],
},
{
key: 'trace_continuation_strategy',
validation: traceContinuationStrategyRt,
type: 'select',
defaultValue: 'continue',
label: i18n.translate(
'xpack.apm.agentConfig.traceContinuationStrategy.label',
{
defaultMessage: 'Trace continuation strategy',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.traceContinuationStrategy.description',
{
defaultMessage:
'This option allows some control over how the APM agent handles W3C trace-context headers on incoming requests. By default, the `traceparent` and `tracestate` headers are used per W3C spec for distributed tracing. However, in certain cases it can be helpful to not use the incoming `traceparent` header. Some example use cases:\n' +
'\n' +
'* An Elastic-monitored service is receiving requests with `traceparent` headers from unmonitored services.\n' +
'* An Elastic-monitored service is publicly exposed, and does not want tracing data (trace-ids, sampling decisions) to possibly be spoofed by user requests.\n' +
'\n' +
'Valid values are:\n' +
"* 'continue': The default behavior. An incoming `traceparent` value is used to continue the trace and determine the sampling decision.\n" +
"* 'restart': Always ignores the `traceparent` header of incoming requests. A new trace-id will be generated and the sampling decision will be made based on transaction_sample_rate. A span link will be made to the incoming `traceparent`.\n" +
"* 'restart_external': If an incoming request includes the `es` vendor flag in `tracestate`, then any `traceparent` will be considered internal and will be handled as described for 'continue' above. Otherwise, any `traceparent` is considered external and will be handled as described for 'restart' above.\n" +
'\n' +
'Starting with Elastic Observability 8.2, span links are visible in trace views.\n' +
'\n' +
'This option is case-insensitive.',
}
),
options: [
{ text: 'continue', value: 'continue' },
{ text: 'restart', value: 'restart' },
{ text: 'restart_external', value: 'restart_external' },
],
includeAgents: ['java'],
},
// Transaction max spans
{
key: 'transaction_max_spans',
@ -257,4 +442,76 @@ export const generalSettings: RawSettingDefinition[] = [
),
includeAgents: ['java', 'nodejs', 'python', 'dotnet', 'ruby', 'go'],
},
{
key: 'transaction_ignore_user_agents',
type: 'text',
defaultValue: '',
label: i18n.translate(
'xpack.apm.agentConfig.transactionIgnoreUserAgents.label',
{
defaultMessage: 'Transaction ignore user agents',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.transactionIgnoreUserAgents.description',
{
defaultMessage:
'Used to restrict requests from certain User-Agents from being instrumented.\n' +
'\n' +
'When an incoming HTTP request is detected,\n' +
'the User-Agent from the request headers will be tested against each element in this list.\n' +
'Example: `curl/*`, `*pingdom*`',
}
),
includeAgents: ['java'],
},
{
key: 'use_path_as_transaction_name',
type: 'boolean',
defaultValue: 'false',
label: i18n.translate(
'xpack.apm.agentConfig.usePathAsTransactionName.label',
{
defaultMessage: 'Use path as transaction name',
}
),
description: i18n.translate(
'xpack.apm.agentConfig.usePathAsTransactionName.description',
{
defaultMessage:
'If set to `true`,\n' +
'transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.\n' +
'\n' +
'WARNING: If your URLs contain path parameters like `/user/$userId`,\n' +
'you should be very careful when enabling this flag,\n' +
'as it can lead to an explosion of transaction groups.\n' +
'Take a look at the `transaction_name_groups` option on how to mitigate this problem by grouping URLs together.',
}
),
includeAgents: ['java'],
},
{
key: 'transaction_name_groups',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.transactionNameGroups.label', {
defaultMessage: 'Transaction name groups',
}),
description: i18n.translate(
'xpack.apm.agentConfig.transactionNameGroups.description',
{
defaultMessage:
'With this option,\n' +
'you can group transaction names that contain dynamic parts with a wildcard expression.\n' +
'For example,\n' +
'the pattern `GET /user/*/cart` would consolidate transactions,\n' +
'such as `GET /users/42/cart` and `GET /users/73/cart` into a single transaction name `GET /users/*/cart`,\n' +
'hence reducing the transaction name cardinality.',
}
),
includeAgents: ['java'],
},
];

218
x-pack/plugins/apm/common/agent_configuration/setting_definitions/index.test.ts
View file

@ -43,134 +43,150 @@ describe('filterByAgent', () => {
describe('options per agent', () => {
it('go', () => {
expect(getSettingKeysForAgent('go')).toEqual([
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'stack_trace_limit',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('go')).toEqual(
expect.arrayContaining([
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'stack_trace_limit',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('java', () => {
expect(getSettingKeysForAgent('java')).toEqual([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'circuit_breaker_enabled',
'enable_log_correlation',
'log_level',
'profiling_inferred_spans_enabled',
'profiling_inferred_spans_excluded_classes',
'profiling_inferred_spans_included_classes',
'profiling_inferred_spans_min_duration',
'profiling_inferred_spans_sampling_interval',
'recording',
'sanitize_field_names',
'server_timeout',
'span_frames_min_duration',
'stack_trace_limit',
'stress_monitor_cpu_duration_threshold',
'stress_monitor_gc_relief_threshold',
'stress_monitor_gc_stress_threshold',
'stress_monitor_system_cpu_relief_threshold',
'stress_monitor_system_cpu_stress_threshold',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('java')).toEqual(
expect.arrayContaining([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'circuit_breaker_enabled',
'enable_log_correlation',
'log_level',
'profiling_inferred_spans_enabled',
'profiling_inferred_spans_excluded_classes',
'profiling_inferred_spans_included_classes',
'profiling_inferred_spans_min_duration',
'profiling_inferred_spans_sampling_interval',
'recording',
'sanitize_field_names',
'server_timeout',
'span_frames_min_duration',
'stack_trace_limit',
'stress_monitor_cpu_duration_threshold',
'stress_monitor_gc_relief_threshold',
'stress_monitor_gc_stress_threshold',
'stress_monitor_system_cpu_relief_threshold',
'stress_monitor_system_cpu_stress_threshold',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('js-base', () => {
expect(getSettingKeysForAgent('js-base')).toEqual([
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('js-base')).toEqual(
expect.arrayContaining(['transaction_sample_rate'])
);
});
it('rum-js', () => {
expect(getSettingKeysForAgent('rum-js')).toEqual([
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('rum-js')).toEqual(
expect.arrayContaining(['transaction_sample_rate'])
);
});
it('nodejs', () => {
expect(getSettingKeysForAgent('nodejs')).toEqual([
'capture_body',
'log_level',
'sanitize_field_names',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('nodejs')).toEqual(
expect.arrayContaining([
'capture_body',
'log_level',
'sanitize_field_names',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('python', () => {
expect(getSettingKeysForAgent('python')).toEqual([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('python')).toEqual(
expect.arrayContaining([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('dotnet', () => {
expect(getSettingKeysForAgent('dotnet')).toEqual([
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'stack_trace_limit',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('dotnet')).toEqual(
expect.arrayContaining([
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'stack_trace_limit',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('ruby', () => {
expect(getSettingKeysForAgent('ruby')).toEqual([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('ruby')).toEqual(
expect.arrayContaining([
'api_request_size',
'api_request_time',
'capture_body',
'capture_headers',
'log_level',
'recording',
'sanitize_field_names',
'span_frames_min_duration',
'transaction_ignore_urls',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('php', () => {
expect(getSettingKeysForAgent('php')).toEqual([
'log_level',
'recording',
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent('php')).toEqual(
expect.arrayContaining([
'log_level',
'recording',
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
it('"All" services (no agent name)', () => {
expect(getSettingKeysForAgent(undefined)).toEqual([
'transaction_max_spans',
'transaction_sample_rate',
]);
expect(getSettingKeysForAgent(undefined)).toEqual(
expect.arrayContaining([
'transaction_max_spans',
'transaction_sample_rate',
])
);
});
});
});

91
x-pack/plugins/apm/common/agent_configuration/setting_definitions/java_settings.ts
View file

@ -238,4 +238,95 @@ export const javaSettings: RawSettingDefinition[] = [
),
includeAgents: ['java'],
},
{
key: 'capture_jmx_metrics',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.captureJmxMetrics.label', {
defaultMessage: 'Capture JMX metrics',
}),
description: i18n.translate(
'xpack.apm.agentConfig.captureJmxMetrics.description',
{
defaultMessage:
'Report metrics from JMX to the APM Server\n' +
'\n' +
'Can contain multiple comma separated JMX metric definitions:\n' +
'\n' +
'`object_name[<JMX object name pattern>] attribute[<JMX attribute>:metric_name=<optional metric name>]`\n' +
'\n' +
'See the Java agent documentation for more details.',
}
),
includeAgents: ['java'],
},
{
key: 'ignore_exceptions',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.ignoreExceptions.label', {
defaultMessage: 'Ignore exceptions',
}),
description: i18n.translate(
'xpack.apm.agentConfig.ignoreExceptions.description',
{
defaultMessage:
'A list of exceptions that should be ignored and not reported as errors.\n' +
'This allows to ignore exceptions thrown in regular control flow that are not actual errors.',
}
),
includeAgents: ['java'],
},
{
key: 'trace_methods',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.traceMethods.label', {
defaultMessage: 'Trace methods',
}),
description: i18n.translate(
'xpack.apm.agentConfig.traceMethods.description',
{
defaultMessage:
'A list of methods for which to create a transaction or span.\n' +
'\n' +
'If you want to monitor a large number of methods,\n' +
'use `profiling_inferred_spans_enabled`.\n' +
'\n' +
'This works by instrumenting each matching method to include code that creates a span for the method.\n' +
'While creating a span is quite cheap in terms of performance,\n' +
'instrumenting a whole code base or a method which is executed in a tight loop leads to significant overhead.\n' +
'\n' +
'NOTE: Only use wildcards if necessary.\n' +
'The more methods you match the more overhead will be caused by the agent.\n' +
'Also note that there is a maximum amount of spans per transaction `transaction_max_spans`.\n' +
'\n' +
'See the Java agent documentation for more details.',
}
),
includeAgents: ['java'],
},
{
key: 'unnest_exceptions',
type: 'text',
defaultValue: '',
label: i18n.translate('xpack.apm.agentConfig.unnestExceptions.label', {
defaultMessage: 'Unnest exceptions',
}),
description: i18n.translate(
'xpack.apm.agentConfig.unnestExceptions.description',
{
defaultMessage:
'When reporting exceptions,\n' +
'un-nests the exceptions matching the wildcard pattern.\n' +
"This can come in handy for Spring's `org.springframework.web.util.NestedServletException`,\n" +
'for example.',
}
),
includeAgents: ['java'],
},
];