2021-08-05 19:31:02 -04:00
---
layout: docs
2023-07-07 14:42:11 -04:00
page_title: Controller/worker - events
2021-08-05 19:31:02 -04:00
description: |-
The events stanza configures events-specific parameters.
---
2023-07-07 14:42:11 -04:00
# `events` stanza
2021-08-05 19:31:02 -04:00
2021-10-13 13:57:31 -06:00
The `events` stanza configures Boundary events-specific parameters.
2021-08-05 19:31:02 -04:00
Example:
```hcl
events {
observations_enabled = true
sysevents_enabled = true
2023-09-22 07:17:26 -04:00
telemetry_enabled = false
2021-10-13 13:57:31 -06:00
sink "stderr" {
2021-08-05 19:31:02 -04:00
name = "all-events"
description = "All events sent to stderr"
event_types = ["*"]
format = "hclog-text"
}
2021-10-13 13:57:31 -06:00
sink {
2021-08-05 19:31:02 -04:00
name = "obs-sink"
description = "Observations sent to a file"
event_types = ["observation"]
format = "cloudevents-json"
file {
2022-06-10 13:30:05 -04:00
path = "/var/log/boundary"
file_name = "events.ndjson"
2021-08-05 19:31:02 -04:00
}
}
}
```
2023-07-07 14:42:11 -04:00
- `audit_enabled` - Specifies if audit events should be emitted.
2021-08-05 19:31:02 -04:00
2021-10-13 13:57:31 -06:00
- `observations_enabled` - Specifies if observation events should be emitted.
2021-08-05 19:31:02 -04:00
2021-10-13 13:57:31 -06:00
- `sysevents_enabled` - Specifies if system events should be emitted.
2021-08-05 19:31:02 -04:00
2023-09-22 07:17:26 -04:00
- `telemetry_enabled` - Specifies if telemetry events should be emitted.
To receive telemetry events, you must also set `observations_enabled` to `true`.
2021-08-05 19:31:02 -04:00
- `sink` - Specifies the configuration of an event sink. Currently, two types of
2023-01-20 18:17:34 -05:00
sink are supported: [file](/boundary/docs/configuration/events/file) and [stderr](/boundary/docs/configuration/events/stderr). If no sinks are configured then all
events will be sent to a default [stderr](/boundary/docs/configuration/events/stderr) sink. Events may be sent to multiple
2021-10-13 13:57:31 -06:00
sinks.
2023-07-07 14:42:11 -04:00
## Default events stanza
2021-08-05 19:31:02 -04:00
If no event stanza is specified then the following default is used:
2021-10-13 13:57:31 -06:00
2021-08-05 19:31:02 -04:00
```hcl
events {
audit_enabled = false
observations_enabled = true
sysevents_enabled = true
2023-09-22 07:17:26 -04:00
telemetry_enabled = false
2021-10-13 13:57:31 -06:00
sink "stderr" {
2021-08-05 19:31:02 -04:00
name = "default"
event_types = ["*"]
format = "cloudevents-json"
}
2022-07-20 20:33:27 +01:00
}
2021-08-05 19:31:02 -04:00
```