Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about '/liveness' endpoint for standalone agent #1090

Merged
merged 4 commits into from
Jun 4, 2024
Merged

Add note about '/liveness' endpoint for standalone agent #1090

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5b7114
Add note about '/liveness' endpoint for standalone agent
kilfoyle May 28, 2024
306b4cd
fixup
kilfoyle May 28, 2024
e1a26ea
Add 'Enable agent monitoring' to policy settings page
kilfoyle May 28, 2024
571ff93
Update docs/en/ingest-management/elastic-agent/configuration/elastic-…
kilfoyle Jun 3, 2024
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
6 changes: 6 additions & 0 deletions ...ingest-management/elastic-agent/configuration/elastic-agent-monitoring.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ To enable monitoring, set `agent.monitoring.enabled` to `true`. Also set the
collected. If neither setting is specified, monitoring is turned off. Set
`use_output` to specify the output to which monitoring events are sent.

Setting `agent.monitoring.enabled` to `true` also enables a `/liveness` endpoint to be
available where that server is configured to be exposed. By default, the endpoint
returns a `200` OK status as long as {agent}'s internal main loop is responsive and can
process configuration changes. It can be configured to also monitor the component states
to return an error if anything is degraded or failed.
kilfoyle marked this conversation as resolved.
Show resolved Hide resolved

The `agent.monitoring.pprof.enabled` option controls whether the {agent} and {beats} expose the
`/debug/pprof/` endpoints with the monitoring endpoints. It is set to `false`
by default. Data produced by these endpoints can be useful for debugging but present a
Expand Down