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.

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

Conversation

darianm23
Copy link

closes #616 by nesting bullets under field.

Comment on lines +66 to +68
* `type` - (Required) Must be set to "eq" currently
* `from` - (Required) The record value to map from
* `to` - (Required) The severity value to map to
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

Copy link
Collaborator

@sumovishal sumovishal left a comment

Choose a reason for hiding this comment

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

Left a comment, approving to unblock merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ambiguous arguments in aggregation rule documentation
3 participants