events stanza
events stanza
The events stanza configures which audit, observation, system, and telemetry events Boundary emits and where they're sent.
Example:
events {
observations_enabled = true
sysevents_enabled = true
telemetry_enabled = false
sink "stderr" {
name = "all-events"
description = "All events sent to stderr"
event_types = ["*"]
format = "hclog-text"
}
sink {
name = "obs-sink"
description = "Observations sent to a file"
event_types = ["observation"]
format = "cloudevents-json"
file {
path = "/var/log/boundary"
file_name = "events.ndjson"
}
}
}
Configure the log directory
When you configure a file sink, the path parameter specifies the directory
where Boundary writes the file named by file_name. Create the directory
before you start Boundary and give the Boundary service user write access to it.
For example, the following commands create the /var/log/boundary directory
and prepare it for a Boundary service that runs as the boundary user and
group:
$ sudo mkdir -p /var/log/boundary
$ sudo chown boundary:boundary /var/log/boundary
$ sudo chmod 750 /var/log/boundary
These commands produce no output when they succeed.
Replace boundary:boundary with the user and group that run the Boundary
service. For more information, refer to Set logging permissions in the
Boundary Enterprise deployment guide.
Default events stanza
If no event stanza is specified then the following default is used:
events {
audit_enabled = false
observations_enabled = true
sysevents_enabled = true
telemetry_enabled = false
sink "stderr" {
name = "default"
event_types = ["*"]
format = "cloudevents-json"
}
}
Edit this page on GitHub