Docs Changes for v0.8.0 (#2024)

* added new metrics doc * Minor format fixes * Use table to list metrics * Update website/content/docs/operations/index.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * fixed sentence * added worker proxy http * Update website/content/docs/operations/metrics.mdx Co-authored-by: Todd <github@quaddi.com> * Update based on the changes in draft * remove WIP note * Update website/content/docs/operations/metrics.mdx Co-authored-by: Todd <github@quaddi.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Todd <github@quaddi.com> * Update website/content/docs/operations/index.mdx Co-authored-by: Todd <github@quaddi.com> * Removed invalid metrics * Update header level * added code styling for "ops" listener and port 9203 description * added health endpoint document * resolved cherry-pick confict for 5edac3a7418f80e7d528f2fa7a461b1125c11806 * Incorporate review feedback * removed bad reference to metrics * added Other section for boundary_build_info * fixed typo * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Changed release notes structure Removed the empty "Releases" folder and now it goes straight to "Release Notes" * Update website/content/docs/operations/health.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * Incorporate review feedback * Update website/content/docs/operations/index.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * added tutorial link * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * Update website/content/docs/operations/metrics.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * 0.8 Release Notes Added release notes page for 0.8 * corrected sensitive info redaction note * cleaned up visibility overview Co-authored-by: taoism4504 <loann@hashicorp.com> Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com> Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> Co-authored-by: Todd <github@quaddi.com> Co-authored-by: Timothy Messier <tim.messier@gmail.com> Co-authored-by: XingLu Wang <xinglu.wang@hashicorp.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
2022-05-03 16:24:04 -04:00
1 parent f39553abb3
commit bc86b4e9e9
@@ -14,9 +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`.  
-  
-  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.
+  Can be `*`, `error`, `system`, `observation` or `audit`.

 - `event_source_url` - Specifies an optional event source URL for the sink.  If
  not specified a default source will be composed of the
@@ -25,7 +23,7 @@ These parameters are shared across all sink types:
 - `allow_filters` - Specifies a set predicates for including an event in the
  sink. If any filter matches, the event will be included. For more information,
  on using filters see: [event filtering](/docs/concepts/filtering/events)
-  
+
 - `deny-filters` - Specifies a set predicates for excluding an event in the
  sink. If any filter matches, the event will be excluded. For more information
  on using filters see: [event filtering](/docs/concepts/filtering/events)
@@ -34,3 +32,55 @@ These parameters are shared across all sink types:
  `cloudevents-text`, `hclog-json`, or `hclog-text`.

 - `type` - Specifies the type of sink.  Can be `stderr` or `file`.
+
+- `audit_config` - Specifies configuration for the processing of audit events
+    for the sink. This is ignored if the sink is not configured to receive
+    `audit` events.
+
+## `audit_config` parameters
+
+- `audit_filter_overrides` - Specifies overrides for the filter operations that
+    are applied to audit events.
+
+### `audit_filter_overrides` parameters
+
+- `sensitive` `(string: "", "encrypt", "hmac-sha256", "redact")` - Specifies
+    the filter operation to apply to fields that are classified as sensitive.
+
+- `secret` `(string: "", "encrypt", "hmac-sha256", "redact")` - Specifies
+    the filter operation to apply to fields that are classified as secret.
+
+## `audit_config` Examples
+
+This example is equivalent to the default settings if no `audit_config` stanza
+is provided.
+
+```hcl
+audit_config {
+  audit_filter_overrides {
+    sensitive = "redact"
+    secret    = "redact"
+  }
+}
+```
+
+This example will HMAC sensitive fields, and encrypt secrets.
+
+```hcl
+audit_config {
+  audit_filter_overrides {
+    sensitive = "hmac-sha256"
+    secret    = "encrypt"
+  }
+}
+```
+
+This example will not apply a filter to sensitive fields.
+
+```hcl
+audit_config {
+  audit_filter_overrides {
+    sensitive = ""
+  }
+}
+```
@@ -34,7 +34,6 @@ events {
 ```

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