Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disambiguated cse_aggregation_rule documentation #619

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

disambiguated cse_aggregation_rule documentation #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/docs/r/cse_aggregation_rule.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ The following arguments are supported:
+ `default` - (Optional) The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
+ `field` - (Optional) The field to use in the "fieldValue"/"fieldValueMapping" cases.
+ `mapping` - (Optional) The map of record values to severities to use in the "fieldValueMapping" case
- `type` - (Required) Must be set to "eq" currently
- `from` - (Required) The record value to map from
- `to` - (Required) The severity value to map to
* `type` - (Required) Must be set to "eq" currently
* `from` - (Required) The record value to map from
* `to` - (Required) The severity value to map to
Comment on lines +66 to +68
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should work

- `severity_mapping` - (Required) The configuration of how the severity of the Signals should be mapped from the Records
    - `type` - (Required) Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
    - `default` - (Optional) The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
    - `field` - (Optional) The field to use in the "fieldValue"/"fieldValueMapping" cases.
    - `mapping` - (Optional) The map of record values to severities to use in the "fieldValueMapping" case
        - `type` - (Required) Must be set to "eq" currently
        - `from` - (Required) The record value to map from
        - `to` - (Required) The severity value to map to
- `summary_expression` - (Optional) The summary of the generated Signals

- `summary_expression` - (Optional) The summary of the generated Signals
- `tags` - (Required) The tags of the generated Signals
- `trigger_expression` - (Required) The expression to determine whether a Signal should be created based on the aggregation results
Expand Down
Loading