Skip to content

Commit 3ea3271

Browse files
committed
docs: Remove redundancy
1 parent 9cd24cb commit 3ea3271

File tree

2 files changed

+45
-31
lines changed

2 files changed

+45
-31
lines changed

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

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,21 @@ description: |-
77

88
# Configure events
99

10-
You can log system information in a well-defined, structured format that give you visibility into emitted events.
10+
The [`events`](/docs/configuration/events) stanza lets you log system information in a well-defined, structured format that gives you visibility into emitted events.
1111

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:
12+
You configure emitted events and sinks in the configuration file for any controller or worker server.
13+
Complete the following steps to configure events:
1514

16-
- `stderr` - Sends events to a stderr.
17-
- `file` - Sends events to a file.
18-
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.
20-
21-
When you configure a sink, you can specify what types of events Boundary should emit:
22-
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.
15+
1. Open the configuration file for the controller or worker server that you want to emit events.
16+
1. Edit the `events` stanza in the configuration file.
17+
Set the following to `true` to emit that type of event, and then configure any sinks:
18+
- `audit_enabled` - Specifies if Boundary emits audit events.
19+
- `observations_enabled` - Specifies if Boundary emits observation events.
20+
- `sysevents_enabled` - Specifies if Boundary should emit system events.
21+
- `telemetry_enabled` - Specifies if Boundary should emit telemetry events.
2722
To receive telemetry events, you must also set `observations_enabled` to `true`.
23+
1. Save the file.
2824

29-
You configure event sinks in the configuration file for a controller or worker server.
3025
The following example includes the contents of the `events` stanza in the `compose/controller.hcl` configuration file:
3126

3227
<CodeBlockConfig hideClipboard>
@@ -66,4 +61,10 @@ events {
6661
}
6762
```
6863

69-
</CodeBlockConfig>
64+
</CodeBlockConfig>
65+
66+
## More information
67+
68+
Refer to the `events` stanza [Overview](/docs/configuration/events) for more information about monitoring events for a controller or worker.
69+
70+
Refer to [Telemetry data](/docs/configuration/events/telemetry-data) for a list of the events and data you can track by enabling telemetry events.

website/content/docs/configuration/events/index.mdx

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,29 @@ description: |-
77

88
# `events` stanza
99

10+
You can log system information in a well-defined, structured format that give you visibility into emitted events.
1011
The `events` stanza configures Boundary events-specific parameters.
1112

13+
14+
15+
16+
You can specify what types of events Boundary should emit:
17+
18+
- `audit_enabled` - Specifies if Boundary emits audit events.
19+
- `observations_enabled` - Specifies if Boundary emits observation events.
20+
- `sysevents_enabled` - Specifies if Boundary should emit system events.
21+
- `telemetry_enabled` - Specifies if Boundary should emit telemetry events.
22+
To receive telemetry events, you must also set `observations_enabled` to `true`.
23+
24+
Event sinks provide a location for Boundary to write events to.
25+
You can configure sinks to allow or deny specific event types using filter syntax:
26+
27+
- `sink` - Specifies the configuration of an event sink.
28+
Currently, two types of sinks are supported: [file](/boundary/docs/configuration/events/file) and [stderr](/boundary/docs/configuration/events/stderr).
29+
30+
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.
31+
If no sinks are configured, then all events will be sent to a default [stderr](/boundary/docs/configuration/events/stderr) sink.
32+
1233
Example:
1334

1435
```hcl
@@ -35,20 +56,6 @@ events {
3556
}
3657
```
3758

38-
- `audit_enabled` - Specifies if audit events should be emitted.
39-
40-
- `observations_enabled` - Specifies if observation events should be emitted.
41-
42-
- `sysevents_enabled` - Specifies if system events should be emitted.
43-
44-
- `telemetry_enabled` - Specifies if telemetry events should be emitted.
45-
To receive telemetry events, you must also set `observations_enabled` to `true`.
46-
47-
- `sink` - Specifies the configuration of an event sink. Currently, two types of
48-
sink are supported: [file](/boundary/docs/configuration/events/file) and [stderr](/boundary/docs/configuration/events/stderr). If no sinks are configured then all
49-
events will be sent to a default [stderr](/boundary/docs/configuration/events/stderr) sink. Events may be sent to multiple
50-
sinks.
51-
5259
## Default events stanza
5360

5461
If no event stanza is specified then the following default is used:
@@ -66,3 +73,9 @@ events {
6673
}
6774
}
6875
```
76+
77+
## Next steps
78+
79+
Refer to [Configure events](/docs/configuration/events/configure-events) to configure a controller or worker server to emit events.
80+
81+
Refer to [Telemetry data](/docs/configuration/events/telemetry-data) for a list of the events and data you can track by enabling telemetry events.

0 commit comments

Comments
 (0)