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

Jump to bottom

Converting IRIS Alert Source from Hardcoded to Dynamic Alert Field Variable #1531

Merged
merged 7 commits into from
Sep 9, 2024
Merged

Converting IRIS Alert Source from Hardcoded to Dynamic Alert Field Variable #1531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
461f21f
Update iris.py to allow for dynamic alert source field
bvirgilioamnh Sep 7, 2024
4a80c1b
Updating documentation for new alert source field option
bvirgilioamnh Sep 7, 2024
0978484
Update maximal alert tests to include newly modified alert source field
bvirgilioamnh Sep 7, 2024
4373af1
Update change log to reflex changes to IRIS alerter
bvirgilioamnh Sep 7, 2024
ae027a5
Fixing iris test duplicate alert_sources
bvirgilioamnh Sep 7, 2024
ce95498
Fixing iris_alert_source field formating
bvirgilioamnh Sep 7, 2024
e97d1a3
Update schema.yaml to include new iris_alert_source field
bvirgilioamnh Sep 9, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

## Other changes
- [Indexer] Fixed fields types error on instance indexer_alert_config in schema.yml - [#1499](https://github.com/jertel/elastalert2/pull/1499) - @olehpalanskyi
- [IRIS] Changed alert_source field from static 'ElastAlert2' value to field iris_alert_source value with default of 'ElastAlert2' - @bvirgilioamnh

# 2.19.0

Expand Down
2 changes: 2 additions & 0 deletions docs/source/alerts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,8 @@ Optional:

``iris_alert_note``: Note for the alert.

``iris_alert_source``: Source of the alert. Default value is ``ElastAlert2``.

``iris_alert_tags``: List of tags.

``iris_alert_status_id``: The alert status of the alert, default value is ``2``. This parameter requires an integer input.
Expand Down
3 changes: 2 additions & 1 deletion elastalert/alerters/iris.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ def __init__(self, rule):
'Authorization': f'Bearer {self.rule.get("iris_api_token")}'
}
self.alert_note = self.rule.get('iris_alert_note', None)
self.alert_source = self.rule.get('iris_alert_source', 'ElastAlert2')
self.alert_tags = self.rule.get('iris_alert_tags', None)
self.alert_status_id = self.rule.get('iris_alert_status_id', 2)
self.alert_source_link = self.rule.get('iris_alert_source_link', None)
Expand Down Expand Up @@ -78,7 +79,7 @@ def make_alert(self, matches):
alert_data = {
"alert_title": self.rule.get('name'),
"alert_description": self.description,
"alert_source": "ElastAlert2",
"alert_source": self.alert_source,
"alert_severity_id": self.alert_severity_id,
"alert_status_id": self.alert_status_id,
"alert_source_event_time": event_timestamp,
Expand Down
1 change: 1 addition & 0 deletions elastalert/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@ properties:
iris_alert_note: {type: string}
iris_alert_tags: {type: string}
iris_alert_status_id: {type: integer, enum: [1, 2, 3, 4, 5, 6, 7]}
iris_alert_source: {type: string}
iris_alert_source_link: {type: string}
iris_alert_severity_id: {type: integer, enum: [1, 2, 3, 4, 5, 6]}
iris_iocs: *arrayOfIrisIocFields
Expand Down
6 changes: 4 additions & 2 deletions tests/alerters/iris_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ def test_iris_make_alert_maximal(caplog):
'iris_alert_tags': 'test, alert',
'iris_overwrite_timestamp': True,
'iris_alert_source_link': 'https://example.com',
'iris_alert_source': "TestSource",
'iris_iocs': [
{
'ioc_description': 'source address',
Expand Down Expand Up @@ -187,7 +188,7 @@ def test_iris_make_alert_maximal(caplog):
expected_data = {
"alert_title": 'Test Maximal Alert Body',
"alert_description": 'test description in alert',
"alert_source": "ElastAlert2",
"alert_source": "TestSource",
"alert_severity_id": 1,
"alert_status_id": 2,
"alert_source_event_time": '2023-10-21 20:00:00.000',
Expand Down Expand Up @@ -235,6 +236,7 @@ def test_iris_make_alert_maximal_with_nested_json(caplog):
'iris_alert_tags': 'test, alert',
'iris_overwrite_timestamp': True,
'iris_alert_source_link': 'https://example.com',
'iris_alert_source': "TestSource",
'iris_iocs': [
{
'ioc_description': 'source address',
Expand Down Expand Up @@ -267,7 +269,7 @@ def test_iris_make_alert_maximal_with_nested_json(caplog):
expected_data = {
"alert_title": 'Test Maximal Alert Body',
"alert_description": 'test description in alert',
"alert_source": "ElastAlert2",
"alert_source": "TestSource",
"alert_severity_id": 1,
"alert_status_id": 2,
"alert_source_event_time": '2023-10-21 20:00:00.000',
Expand Down