Skip to content

Commit d22bbd4

Browse files
committed
docs: Adds new topic
1 parent faf01ea commit d22bbd4

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: docs
3+
page_title: Configure events
4+
description: |-
5+
Configure log event sinks to monitor Boundary resources and actions.
6+
---
7+
8+
# Configure events
9+
10+
You can log system information in a well-defined, structured format that give you visibility into emitted events.
11+
12+
Event sinks provide a location for Boundary to write events to.
13+
You can configure sinks to allow or deny specific event types using filter syntax.
14+
There are two types of event sinks:
15+
16+
- `stderr` - Sends events to a stderr.
17+
- `file` - Sends events to a file.
18+
19+
You can repeat the `sink` stanza multiple times to send events to multiple sinks, but each file sink must have a unique path and file name.
20+
21+
When you configure a sink, you can specify what types of events should be emitted by Boundary:
22+
23+
- `audit_enabled` - Specifies if audit events should be emitted.
24+
- `observations_enabled` - Specifies if observation events should be emitted.
25+
- `sysevents_enabled` - Specifies if system events should be emitted.
26+
- `telemetry_enabled` - Specifies if telemetry events should be emitted.
27+
To receive telemetry events, you must also set `observations_enabled` to `true`.

website/content/docs/configuration/events/telemetry-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |-
77

88
# Telemetry data
99

10-
If you have telemetry enabled in Boundary, you can view the following information.
10+
If you have telemetry enabled in Boundary, you can view information about the following resources.
1111

1212
## Auth methods
1313

website/data/docs-nav-data.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,10 @@
573573
"title": "Overview",
574574
"path": "configuration/events"
575575
},
576+
{
577+
"title": "Configure event logging",
578+
"path": "configuration/events/configure-events"
579+
},
576580
{
577581
"title": "Common sink parameters",
578582
"path": "configuration/events/common"

0 commit comments

Comments
 (0)