Skip to content

Commit 9cd24cb

Browse files
committed
docs: Add config file example
1 parent d22bbd4 commit 9cd24cb

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

website/content/docs/configuration/events/configure-events.mdx

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,54 @@ There are two types of event sinks:
1616
- `stderr` - Sends events to a stderr.
1717
- `file` - Sends events to a file.
1818

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.
19+
You can repeat the `sink` stanza more than once to send events to multiple sinks, but each file sink must have a unique path and file name.
2020

21-
When you configure a sink, you can specify what types of events should be emitted by Boundary:
21+
When you configure a sink, you can specify what types of events Boundary should emit:
2222

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`.
23+
- `audit_enabled` - Specifies if Boundary emits audit events.
24+
- `observations_enabled` - Specifies if Boundary emits observation events.
25+
- `sysevents_enabled` - Specifies if Boundary should emit system events.
26+
- `telemetry_enabled` - Specifies if Boundary should emit telemetry events.
27+
To receive telemetry events, you must also set `observations_enabled` to `true`.
28+
29+
You configure event sinks in the configuration file for a controller or worker server.
30+
The following example includes the contents of the `events` stanza in the `compose/controller.hcl` configuration file:
31+
32+
<CodeBlockConfig hideClipboard>
33+
34+
```hcl
35+
events {
36+
audit_enabled = true
37+
observations_enabled = true
38+
sysevents_enabled = true
39+
telemetry_enabled = true
40+
41+
sink "stderr" {
42+
name = "all-events"
43+
description = "All events sent to stderr"
44+
event_types = ["*"]
45+
format = "cloudevents-json"
46+
}
47+
48+
sink {
49+
name = "controller-audit-sink"
50+
description = "Audit sent to a file"
51+
event_types = ["audit"]
52+
format = "cloudevents-json"
53+
54+
file {
55+
path = "/logs"
56+
file_name = "controller.log"
57+
}
58+
59+
audit_config {
60+
audit_filter_overrides {
61+
secret = "encrypt"
62+
sensitive = "hmac-sha256"
63+
}
64+
}
65+
}
66+
}
67+
```
68+
69+
</CodeBlockConfig>

0 commit comments

Comments
 (0)