events Stanza

The events stanza configures Boundary events-specific parameters.

Example:

  1. events {
  2.   observations_enabled = true
  3.   sysevents_enabled = true
  4.   sink "stderr" {
  5.     name = "all-events"
  6.     description = "All events sent to stderr"
  7.     event_types = ["*"]
  8.     format = "hclog-text"
  9.   }
  10.   sink {
  11.     name = "obs-sink"
  12.     description = "Observations sent to a file"
  13.     event_types = ["observation"]
  14.     format = "cloudevents-json"
  15.     file {
  16.       file_name = "file-name"
  17.     }
  18.   }
  19. }
  1. events {  observations_enabled = true  sysevents_enabled = true  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 {      file_name = "file-name"    }  }}

  • audit_enabled - Specifies if audit events should be emitted.
    Note: audit events are a WIP and will only be emitted if they are both enabled and the env var BOUNDARY_DEVELOPER_ENABLE_EVENTS equals true. We anticipate many changes for audit events before they are generally available including what data is included and different options for redacting/encrypting that data.

  • observations_enabled - Specifies if observation events should be emitted.

  • sysevents_enabled - Specifies if system events should be emitted.

  • 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.

Default Events Stanza

If no event stanza is specified then the following default is used:

  1. events {
  2.   audit_enabled = false
  3.   observations_enabled = true
  4.   sysevents_enabled = true
  5.   sink "stderr" {
  6.     name = "default"
  7.     event_types = ["*"]
  8.     format = "cloudevents-json"
  9.   }
  1. events {  audit_enabled = false  observations_enabled = true  sysevents_enabled = true  sink "stderr" {    name = "default"    event_types = ["*"]    format = "cloudevents-json"  }