-
Notifications
You must be signed in to change notification settings - Fork 298
docs: Document telemetry #4972
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.
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
base: main
Are you sure you want to change the base?
docs: Document telemetry #4972
Changes from 8 commits
49fc1ba
faf01ea
d22bbd4
9cd24cb
3ea3271
248ffc1
83c356a
dca9a0d
32f326c
83375da
07240cf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
layout: docs | ||
page_title: Configure events | ||
description: |- | ||
Configure log event sinks to monitor Boundary resources and actions. | ||
--- | ||
|
||
# Configure event logging | ||
|
||
The [`events`](/boundary/docs/configuration/events) stanza lets you log system information in a well-defined, structured format that gives you visibility into emitted events. | ||
|
||
You configure emitted events and sinks in the configuration file for any [controller](/boundary/docs/configuration/controller) or [worker](/boundary/docs/configuration/worker) server. | ||
Complete the following steps to configure events: | ||
|
||
1. Open the configuration file for the controller or worker server that you want to emit events. | ||
1. Edit the `events` stanza in the configuration file. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this should be item 2 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah yeah, our Markdown standard is a little wonky. That still renders as numbers 2 and 3. It should be OK in the preview deployment: ![]() |
||
Set the following to `true` to emit that type of event, and then configure any sinks: | ||
- `audit_enabled` - Specifies if Boundary emits audit events. | ||
- `observations_enabled` - Specifies if Boundary emits observation events. | ||
- `sysevents_enabled` - Specifies if Boundary should emit system events. | ||
- `telemetry_enabled` - Specifies if Boundary should emit telemetry events. | ||
To receive telemetry events, you must also set `observations_enabled` to `true`. | ||
1. Save the file. | ||
stellarsquall marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The following example includes the contents of the `events` stanza in the `compose/controller.hcl` configuration file: | ||
|
||
<CodeBlockConfig hideClipboard> | ||
|
||
```hcl | ||
events { | ||
audit_enabled = true | ||
observations_enabled = true | ||
sysevents_enabled = true | ||
telemetry_enabled = true | ||
|
||
sink "stderr" { | ||
name = "all-events" | ||
description = "All events sent to stderr" | ||
event_types = ["*"] | ||
format = "cloudevents-json" | ||
} | ||
|
||
sink { | ||
name = "controller-audit-sink" | ||
description = "Audit sent to a file" | ||
event_types = ["audit"] | ||
format = "cloudevents-json" | ||
|
||
file { | ||
path = "/logs" | ||
file_name = "controller.log" | ||
} | ||
|
||
audit_config { | ||
audit_filter_overrides { | ||
secret = "encrypt" | ||
sensitive = "hmac-sha256" | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
</CodeBlockConfig> | ||
|
||
## More information | ||
|
||
Refer to the `events` stanza [Overview](/boundary/docs/configuration/events) for more information about monitoring events for a controller or worker. | ||
|
||
Refer to [Telemetry data](/boundary/docs/configuration/events/telemetry-data) for a list of the events and data you can track by enabling telemetry events. |
Uh oh!
There was an error while loading. Please reload this page.