Dan HeathandRobin Beck
5ce6515156
* docs: IA reorganization * docs: Updates * docs: Updates * docs: Fix links * docs: Updates * docs: Fix a typo * docs: Fix client agent topic * docs: Update Client Agent nav * docs: Fix conflict * docs: Fix a typo in Client Agent docs (#5853) * docs: Fix client agent topic * docs: Updates * docs: Updates * docs: Updates * docs: Updates * docs: Fixes get started and operations links * docs: Update nav * docs: Partials * docs: Unix partials * docs: Worker partials * docs: Updates * docs: Update workers and targets * docs: Updates * docs: Updates * docs: Fixes link * docs: Updates after sync review * docs: Updates from review feedback * docs: Move worker filter examples * docs: Fix links * docs: Updates for filters based on working session * docs: Fixes broken links * docs: Add links to other filter topics * docs: Update list intro * docs: Adds link * docs: Fixes redirects * docs: Fixes redirects * docs: Deleted mysql page from TOC * docs: Add versioned redirect * docs: Adds versioned redirects * docs: Adds versioned redirects * docs: Update redirects * docs: Update redirects * docs: Redirect fixes * docs: Update redirect format * docs: Fix a typo * docs: Fixes redirects * docs: Fixes redirect * docs: Adds links out to client agent troubleshooting * uses /etc/boundary.d/ as recommended installation directory (#6003) * docs: Updates legacy io links * docs: Fixes redirects * docs: Fix redirect * docs: Restoring deleted file --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
57 lines
2.6 KiB
Plaintext
57 lines
2.6 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Monitor Boundary
|
|
description: >-
|
|
Discover resources to help you learn more about maintaining and operating Boundary, including information about metrics and health.
|
|
---
|
|
|
|
# Monitor Boundary
|
|
|
|
Visibility into various components of Boundary plays an important role in
|
|
ensuring the health of its controllers and workers.
|
|
|
|
You can export metrics for controllers
|
|
and workers and then configure them to be collected by Prometheus. Metrics
|
|
provide insight into the current state of a Boundary deployment by enabling the
|
|
diagnosis of deployed controllers and workers. Enabling metrics assists in the
|
|
detection and mitigation of anomalies in a deployment.
|
|
These docs describe the available metrics and the naming and labeling standards
|
|
used.
|
|
|
|
Additionally, the health of controllers can be monitored using the
|
|
`/health` endpoint. The health endpoint is enabled by defining a listener in
|
|
Boundary's configuration file, and a health response may be configured to add a
|
|
shutdown grace period process.
|
|
|
|
You can also configure Boundary to monitor events.
|
|
You can choose to monitor audit, observation, system, and telemetry events.
|
|
Boundary supports both file and stderr sinks for events and you can send events to multiple sinks.
|
|
|
|
Listeners let you configure the addresses and ports on which Boundary responds to requests.
|
|
You can configure TCP and Unix listeners.
|
|
Boundary also supports custom response headers for any requests made on controllers.
|
|
You can define headers based on the status code that is returned.
|
|
|
|
## Tutorials
|
|
|
|
To learn how to configure event filtering and sinks, complete the [Event filtering and sink configuration](/boundary/tutorials/self-managed-deployment/event-logging) tutorial.
|
|
|
|
To learn how to configure metrics collection, complete the [Visualize metrics with Prometheus](/boundary/tutorials/self-managed-deployment/prometheus-metrics) tutorial.
|
|
|
|
## More information
|
|
|
|
Refer to the following topics for the parameters you use to configure the addresses and ports on which Boundary responds to requests:
|
|
|
|
- [Listeners](/boundary/docs/monitor/listeners)
|
|
- [TCP listeners](/boundary/docs/monitor/listeners/tcp)
|
|
- [Unix listeners](/boundary/docs/monitor/listeners/unix)
|
|
|
|
Refer to the following topics for more information on the various ways to monitor Boundary:
|
|
|
|
- [Monitor metrics](/boundary/docs/monitor/metrics)
|
|
- [Monitor health](/boundary/docs/monitor/health)
|
|
- [Monitor events](/boundary/docs/monitor/events)
|
|
- [Common sink parameters](/boundary/docs/monitor/events/common)
|
|
- [File sink](/boundary/docs/monitor/events/file)
|
|
- [Stderr sink](/boundary//docs/monitor/events/stderr)
|