Skip to content

Commit 36e847b

Browse files
pickypgmergify[bot]
pickypg
authored and
mergify[bot]
committed
[AutoOps] Provide Sample Configuration to Debug Data (#10268)
This provides a separate OTel configuration to allow users to better understand what data they are shipping with the AutoOps ES module. (cherry picked from commit 8f1cc86)
1 parent 41df190 commit 36e847b

File tree

5 files changed

+192
-3
lines changed

5 files changed

+192
-3
lines changed

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ changelog/fragments/
2828
/internal/pkg/otel/samples @elastic/ingest-otel-data @elastic/ingest-docs
2929
/internal/pkg/otel/core-components.yaml @elastic/ingest-otel-leads
3030
/internal/pkg/composable/providers/kubernetes @elastic/elastic-agent-control-plane
31-
/internal/pkg/otel/samples/darwin/autoops_es.yml @elastic/opex
32-
/internal/pkg/otel/samples/linux/autoops_es.yml @elastic/opex
33-
/internal/pkg/otel/samples/windows/autoops_es.yml @elastic/opex
31+
/internal/pkg/otel/samples/darwin/autoops_es*.yml @elastic/opex
32+
/internal/pkg/otel/samples/linux/autoops_es*.yml @elastic/opex
33+
/internal/pkg/otel/samples/windows/autoops_es*.yml @elastic/opex

‎changelog/fragments/1759359160-autoops-debug-output.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# REQUIRED
2+
# Kind can be one of:
3+
# - breaking-change: a change to previously-documented behavior
4+
# - deprecation: functionality that is being removed in a later release
5+
# - bug-fix: fixes a problem in a previous version
6+
# - enhancement: extends functionality but does not break or fix existing behavior
7+
# - feature: new functionality
8+
# - known-issue: problems that we are aware of in a given version
9+
# - security: impacts on the security of a product or a user’s deployment.
10+
# - upgrade: important information for someone upgrading from a prior version
11+
# - other: does not fit into any of the other categories
12+
kind: enhancement
13+
14+
# REQUIRED for all kinds
15+
# Change summary; a 80ish characters long description of the change.
16+
summary: Add debug exporter to AutoOps OTel config sample
17+
18+
# REQUIRED for breaking-change, deprecation, known-issue
19+
# Long description; in case the summary is not enough to describe the change
20+
# this field accommodate a description without length limits.
21+
# description:
22+
23+
# REQUIRED for breaking-change, deprecation, known-issue
24+
# impact:
25+
26+
# REQUIRED for breaking-change, deprecation, known-issue
27+
# action:
28+
29+
# REQUIRED for all kinds
30+
# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc.
31+
component: elastic-agent
32+
33+
# AUTOMATED
34+
# OPTIONAL to manually add other PR URLs
35+
# PR URL: A link the PR that added the changeset.
36+
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
37+
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
38+
# Please provide it if you are adding a fragment for a different PR.
39+
# pr: https://github.com/owner/repo/1234
40+
41+
# AUTOMATED
42+
# OPTIONAL to manually add other issue URLs
43+
# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
44+
# If not present is automatically filled by the tooling with the issue linked to the PR number.
45+
# issue: https://github.com/owner/repo/1234

‎internal/pkg/otel/samples/darwin/autoops_es_debug.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
receivers:
2+
metricbeatreceiver:
3+
metricbeat:
4+
modules:
5+
# Metrics
6+
- module: autoops_es
7+
hosts: ${env:AUTOOPS_ES_URL}
8+
period: 10s
9+
metricsets:
10+
- cat_shards
11+
- cluster_health
12+
- cluster_settings
13+
- license
14+
- node_stats
15+
- tasks_management
16+
# Templates
17+
- module: autoops_es
18+
hosts: ${env:AUTOOPS_ES_URL}
19+
period: 24h
20+
metricsets:
21+
- cat_template
22+
- component_template
23+
- index_template
24+
processors:
25+
- add_fields:
26+
target: autoops_es
27+
fields:
28+
temp_resource_id: ${env:AUTOOPS_TEMP_RESOURCE_ID}
29+
token: ${env:AUTOOPS_TOKEN}
30+
output:
31+
otelconsumer:
32+
telemetry_types: ["logs"]
33+
34+
exporters:
35+
# Exporter to print the first 5 logs/metrics and then every 1000th
36+
debug:
37+
verbosity: detailed
38+
sampling_initial: 5
39+
sampling_thereafter: 1000
40+
41+
service:
42+
pipelines:
43+
logs:
44+
receivers: [metricbeatreceiver]
45+
exporters: [debug]
46+
telemetry:
47+
logs:
48+
encoding: json

‎internal/pkg/otel/samples/linux/autoops_es_debug.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
receivers:
2+
metricbeatreceiver:
3+
metricbeat:
4+
modules:
5+
# Metrics
6+
- module: autoops_es
7+
hosts: ${env:AUTOOPS_ES_URL}
8+
period: 10s
9+
metricsets:
10+
- cat_shards
11+
- cluster_health
12+
- cluster_settings
13+
- license
14+
- node_stats
15+
- tasks_management
16+
# Templates
17+
- module: autoops_es
18+
hosts: ${env:AUTOOPS_ES_URL}
19+
period: 24h
20+
metricsets:
21+
- cat_template
22+
- component_template
23+
- index_template
24+
processors:
25+
- add_fields:
26+
target: autoops_es
27+
fields:
28+
temp_resource_id: ${env:AUTOOPS_TEMP_RESOURCE_ID}
29+
token: ${env:AUTOOPS_TOKEN}
30+
output:
31+
otelconsumer:
32+
telemetry_types: ["logs"]
33+
34+
exporters:
35+
# Exporter to print the first 5 logs/metrics and then every 1000th
36+
debug:
37+
verbosity: detailed
38+
sampling_initial: 5
39+
sampling_thereafter: 1000
40+
41+
service:
42+
pipelines:
43+
logs:
44+
receivers: [metricbeatreceiver]
45+
exporters: [debug]
46+
telemetry:
47+
logs:
48+
encoding: json

‎internal/pkg/otel/samples/windows/autoops_es_debug.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
receivers:
2+
metricbeatreceiver:
3+
metricbeat:
4+
modules:
5+
# Metrics
6+
- module: autoops_es
7+
hosts: ${env:AUTOOPS_ES_URL}
8+
period: 10s
9+
metricsets:
10+
- cat_shards
11+
- cluster_health
12+
- cluster_settings
13+
- license
14+
- node_stats
15+
- tasks_management
16+
# Templates
17+
- module: autoops_es
18+
hosts: ${env:AUTOOPS_ES_URL}
19+
period: 24h
20+
metricsets:
21+
- cat_template
22+
- component_template
23+
- index_template
24+
processors:
25+
- add_fields:
26+
target: autoops_es
27+
fields:
28+
temp_resource_id: ${env:AUTOOPS_TEMP_RESOURCE_ID}
29+
token: ${env:AUTOOPS_TOKEN}
30+
output:
31+
otelconsumer:
32+
telemetry_types: ["logs"]
33+
34+
exporters:
35+
# Exporter to print the first 5 logs/metrics and then every 1000th
36+
debug:
37+
verbosity: detailed
38+
sampling_initial: 5
39+
sampling_thereafter: 1000
40+
41+
service:
42+
pipelines:
43+
logs:
44+
receivers: [metricbeatreceiver]
45+
exporters: [debug]
46+
telemetry:
47+
logs:
48+
encoding: json

0 commit comments

Comments
 (0)