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"
    }
  }
}

• audit_enabled - Specifies if audit events should be emitted.

• observations_enabled - Specifies if observation events should be emitted.

• sysevents_enabled - Specifies if system events should be emitted.

• telemetry_enabled - Specifies if telemetry events should be emitted. To receive telemetry events, you must also set observations_enabled to true.

• sink - Specifies the configuration of an event sink. Currently, two types of sink are supported: file and stderr. If no sinks are configured then all events will be sent to a default stderr sink. Events may be sent to multiple sinks. Refer to common sink parameters for fields shared across all sink types.

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"
  }
}