diff --git a/README.md b/README.md index ff40e36b5..51942f8bd 100644 --- a/README.md +++ b/README.md @@ -275,7 +275,10 @@ NOTE: `event_type` is always set to `security` for above events and metrics. #### Filtering events This plugin allows you to filter events by the event type as well as the specific event names listed -above. To include/exclude all events of the system or security type, in the UI, uncheck the checkboxes for these events. In a groovy script, fetch the Datadog global descriptor and call either `d.setEmitSystemEvents()` or `d.setEmitSecurityEvents()`. As listed in the [environment variables](#environment-variables) section, set the environment variables for the emitting security or system events. +above. To include/exclude all events of the system or security type: +- **In the UI**: Uncheck the checkboxes for these events. +- **In a groovy script**: Fetch the Datadog global descriptor and call either `d.setEmitSystemEvents()` or `d.setEmitSecurityEvents()`. +- **In the [environment variables](#environment-variables) section**: Set the environment variables for the emitting security or system events. To get more specific control over what events are sent, three configuration options are provided to allow a comma-separated include/exclude list of strings of event names. The include/exclude list has precedence over filtering by event type. For example, `security` events can be toggled off, but including `UserAuthenticated` takes precedence, so only `UserAuthenticated` events will be sent from the `security` type. In the UI, text boxes are provided for both the included and excluded lists. In a groovy script, the methods `d.setIncludeEvents()` and `d.setExcludeEvents()` accept a comma-separated list of event names as input which is another valid configuration method. Lastly, there are provided [environment variables](#environment-variables) for manually setting included/excluded lists.