Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions reference/fleet/agent-command-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,29 @@
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

Check notice on line 67 in reference/fleet/agent-command-reference.md

View workflow job for this annotation

GitHub Actions / vale

Elastic.WordChoice: Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.
* *_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.

Expand Down
4 changes: 4 additions & 0 deletions reference/fleet/elasticsearch-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,10 @@

**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.

Check notice on line 236 in reference/fleet/elasticsearch-output.md

View workflow job for this annotation

GitHub Actions / vale

Elastic.FutureTense: 'will not' might be in future tense. Write in the present tense to describe the state of the product as it is now.

Check notice on line 236 in reference/fleet/elasticsearch-output.md

View workflow job for this annotation

GitHub Actions / vale

Elastic.WordChoice: Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.

**Default:** `true`

### Data parsing, filtering, and manipulation settings [output-elasticsearch-data-parsing-settings]

Expand Down
4 changes: 4 additions & 0 deletions reference/fleet/es-output-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@

**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.

Check notice on line 136 in reference/fleet/es-output-settings.md

View workflow job for this annotation

GitHub Actions / vale

Elastic.FutureTense: 'will not' might be in future tense. Write in the present tense to describe the state of the product as it is now.

Check notice on line 136 in reference/fleet/es-output-settings.md

View workflow job for this annotation

GitHub Actions / vale

Elastic.WordChoice: Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.

**Default:** `true`

## Performance tuning settings [es-output-settings-performance-tuning-settings]

Expand Down
Loading