From 023ef1e55a166e083c2d21f01df02f65a1620bf4 Mon Sep 17 00:00:00 2001 From: Craig MacKenzie Date: Fri, 28 Nov 2025 16:37:07 -0500 Subject: [PATCH 1/3] Document beat receiver diagnostic files. --- reference/fleet/agent-command-reference.md | 29 ++++++++++++++-------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/reference/fleet/agent-command-reference.md b/reference/fleet/agent-command-reference.md index 11b355b838..d89bb28b2a 100644 --- a/reference/fleet/agent-command-reference.md +++ b/reference/fleet/agent-command-reference.md @@ -46,22 +46,29 @@ Note the following restrictions for running {{agent}} commands: Gather diagnostics information from the {{agent}} and component/unit it’s running. This command produces an archive that contains: * version.txt - version information -* pre-config.yaml - pre-configuration before variable substitution +* agent-info.yaml - Contains the agent local metadata that is also sent to Fleet. +* pre-config.yaml - pre-configuration before variable substitution - this is the elastic-agent.yaml from disk or from Fleet +* otel.yaml - the OpenTelemetry collector configuration file used with the `otel` sub-command +* otel-merged.yaml - the final configuration file provided to the OpenTelemetry collector including any internally generated collector components. * variables.yaml - current variable contexts from providers * computed-config.yaml - configuration after variable substitution * components-expected.yaml - expected computed components model from the computed-config.yaml * components-actual.yaml - actual running components model as reported by the runtime manager * state.yaml - current state information of all running components -* Components Directory - diagnostic information from each running component: - - * goroutine.txt - goroutine dump - * heap.txt - memory allocation of live objects - * allocs.txt - sampling past memory allocations - * threadcreate.txt - traces led to creation of new OS threads - * block.txt - stack traces that led to blocking on synchronization primitives - * mutex.txt - stack traces of holders of contended mutexes - * Unit Directory - If a given unit provides specific diagnostics, it will be placed here. - +* *.pprof.gz files from the running elastic-agent process for analysis with `go tool pprof`: + * goroutine.pprof.gz - goroutine dump + * heap.pprof.gz - memory allocation of live objects + * allocs.pprof.gz - sampling past memory allocations + * threadcreate.pprof.gz - traces led to creation of new OS threads + * block.pprof.gz - stack traces that led to blocking on synchronization primitives + * mutex.pprof.gz - stack traces of holders of contended mutexes +* components/ directory - diagnostic information from each running component process: + * Typically one directory per input-output pair representing a supervised process containing: + * *.pprof.gz - profiles for analysis with `go tool pprof` see descriptions above + * *_metrics.json - metrics snapshots captured from running Beat processes +* edot/ directory - the output of the elasticsdiagnostics collector extension: + * otel-merged-actual.yaml - the configuration the collector is currently running with which should match otel-merged.yaml above + * *.profile.gz - profiles for analysis with `go tool pprof` see descriptions above Note that **credentials may not be redacted** in the archive; they may appear in plain text in the configuration or policy files inside the archive. From 1b90719ddc2a3a8b89e9e271659b10b43201c38c Mon Sep 17 00:00:00 2001 From: Craig MacKenzie Date: Fri, 28 Nov 2025 16:45:30 -0500 Subject: [PATCH 2/3] Document how to disable status reporting. --- reference/fleet/elasticsearch-output.md | 4 ++++ reference/fleet/es-output-settings.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/reference/fleet/elasticsearch-output.md b/reference/fleet/elasticsearch-output.md index 9e8db8783a..fc9f519719 100644 --- a/reference/fleet/elasticsearch-output.md +++ b/reference/fleet/elasticsearch-output.md @@ -232,6 +232,10 @@ The service principal name for the {{es}} instance is constructed from these opt **Default:** `true` +`status_reporting.enabled` $$$output-elasticsearch-fleet-settings-status_reporting.enabled-setting$$$ +: (boolean) Whether status reporting is enabled for this output. When disabled, the output will not change it's health status if there is a connectivity problem. + + **Default:** `true` ### Data parsing, filtering, and manipulation settings [output-elasticsearch-data-parsing-settings] diff --git a/reference/fleet/es-output-settings.md b/reference/fleet/es-output-settings.md index 2fa2451afe..d0417b64b1 100644 --- a/reference/fleet/es-output-settings.md +++ b/reference/fleet/es-output-settings.md @@ -132,6 +132,10 @@ Specify these settings to send data over a secure connection to {{es}}. In the { **Default:** `1` +`status_reporting.enabled` $$$output-elasticsearch-fleet-settings-status_reporting.enabled-setting$$$ +: (boolean) Whether status reporting is enabled for this output. When disabled, the output will not change it's health status if there is a connectivity problem. + + **Default:** `true` ## Performance tuning settings [es-output-settings-performance-tuning-settings] From 75838843bcdd4f9228010316a1233864fe82de62 Mon Sep 17 00:00:00 2001 From: Craig MacKenzie Date: Mon, 1 Dec 2025 16:37:45 -0500 Subject: [PATCH 3/3] Document incoming environment.yaml --- reference/fleet/agent-command-reference.md | 1 + 1 file changed, 1 insertion(+) diff --git a/reference/fleet/agent-command-reference.md b/reference/fleet/agent-command-reference.md index d89bb28b2a..a3ead7100e 100644 --- a/reference/fleet/agent-command-reference.md +++ b/reference/fleet/agent-command-reference.md @@ -51,6 +51,7 @@ Gather diagnostics information from the {{agent}} and component/unit it’s runn * otel.yaml - the OpenTelemetry collector configuration file used with the `otel` sub-command * otel-merged.yaml - the final configuration file provided to the OpenTelemetry collector including any internally generated collector components. * variables.yaml - current variable contexts from providers +* environment.yaml - current environment variables visible to the Elastic Agent process. * computed-config.yaml - configuration after variable substitution * components-expected.yaml - expected computed components model from the computed-config.yaml * components-actual.yaml - actual running components model as reported by the runtime manager