-
Notifications
You must be signed in to change notification settings - Fork 290
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
docs: Document telemetry #4972
Open
Dan-Heath
wants to merge
11
commits into
main
Choose a base branch
from
dheath-telemetry-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
docs: Document telemetry #4972
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
49fc1ba
docs: Document telemetry
Dan-Heath faf01ea
docs: Update with improved table format
Dan-Heath d22bbd4
docs: Adds new topic
Dan-Heath 9cd24cb
docs: Add config file example
Dan-Heath 3ea3271
docs: Remove redundancy
Dan-Heath 248ffc1
docs: Fix broken links
Dan-Heath 83c356a
docs: Fix a typo
Dan-Heath dca9a0d
docs: Updates from review
Dan-Heath 32f326c
Update website/content/docs/configuration/events/configure-events.mdx
Dan-Heath 83375da
Update website/content/docs/configuration/events/telemetry-data.mdx
Dan-Heath 07240cf
docs: Update meta description on index
Dan-Heath File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
website/content/docs/configuration/events/configure-events.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 for controllers and workers 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. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The 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 comment
The 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: