diff --git a/website/content/docs/configuration/events/common.mdx b/website/content/docs/configuration/events/common.mdx index 5bfede66d..9a3e77cb4 100644 --- a/website/content/docs/configuration/events/common.mdx +++ b/website/content/docs/configuration/events/common.mdx @@ -14,7 +14,7 @@ These parameters are shared across all sink types: - `description` - Specify a description for the sink. - `event_types` - Specifies a list of event types that will be sent to the sink. - Can be `*`, `error`, `system`, `observation` or `audit`. + Can be `*`, `audit`, `error`, `observation`, `system`, or `telemetry`. - `event_source_url` - Specifies an optional event source URL for the sink. If not specified, the default source will be composed of the diff --git a/website/content/docs/configuration/events/index.mdx b/website/content/docs/configuration/events/index.mdx index c2480610e..613e28bab 100644 --- a/website/content/docs/configuration/events/index.mdx +++ b/website/content/docs/configuration/events/index.mdx @@ -15,6 +15,7 @@ Example: events { observations_enabled = true sysevents_enabled = true + telemetry_enabled = false sink "stderr" { name = "all-events" description = "All events sent to stderr" @@ -40,6 +41,9 @@ events { - `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](/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 @@ -54,6 +58,7 @@ events { audit_enabled = false observations_enabled = true sysevents_enabled = true + telemetry_enabled = false sink "stderr" { name = "default" event_types = ["*"]