Files
threshold/website/content/docs/configuration/events/overview.mdx
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

63 lines
1.5 KiB
Plaintext
Raw Normal View History

2021-08-05 19:31:02 -04:00
---
layout: docs
page_title: Controller/Worker - Events
description: |-
The events stanza configures events-specific parameters.
---
# `events` Stanza
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
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
}
}
}
```
- `audit_enabled` - Specifies if audit events should be emitted.
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
- `sink` - Specifies the configuration of an event sink. Currently, two types of
sink are supported: [file](/docs/configuration/events/file) and [stderr](/docs/configuration/events/stderr). If no sinks are configured then all
events will be sent to a default [stderr](/docs/configuration/events/stderr) sink. Events may be sent to multiple
2021-10-13 13:57:31 -06:00
sinks.
## 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
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
```