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

[8.1] Document 'execution_summary' response part of detection APIs (backport #1900) #1940

Merged
merged 1 commit into from
May 3, 2022
Merged

[8.1] Document 'execution_summary' response part of detection APIs (backport #1900) #1940

Show file tree
Hide file tree
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
46 changes: 34 additions & 12 deletions docs/detections/api/rules/rules-api-bulk-actions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,12 +331,7 @@ For `enable`, `disable`, `delete`, `edit`, and `duplicate` actions, a JSON objec
"Elastic",
"Network",
"Threat Detection",
"ML",
"777",
"888",
"nine-nine-seven",
"test",
"test-2"
"ML"
],
"interval":"15m",
"enabled":true,
Expand Down Expand Up @@ -380,7 +375,20 @@ For `enable`, `disable`, `delete`, `edit`, and `duplicate` actions, a JSON objec
"throttle":"no_actions",
"actions":[

]
],
"execution_summary": { <1>
"last_execution": {
"date": "2022-03-23T16:06:12.787Z",
"status": "partial failure",
"status_order": 20,
"message": "This rule attempted to query data from Elasticsearch indices listed in the \"Index pattern\" section of the rule definition, but no matching index was found.",
"metrics": {
"total_search_duration_ms": 135,
"total_indexing_duration_ms": 15,
"execution_gap_duration_s": 0,
}
}
}
}
],
"created":[
Expand All @@ -399,6 +407,8 @@ For `enable`, `disable`, `delete`, `edit`, and `duplicate` actions, a JSON objec
}
--------------------------------------------------

<1> dev:[] `execution_summary` is under development and its schema may change.


For an `export` action, an `.ndjson` file containing exported rules.

Expand Down Expand Up @@ -466,10 +476,7 @@ If processing of any rule fails, a partial error outputs the ID and/or name of t
"Windows",
"APM",
"macOS",
"Linux",
"777",
"888",
"nine-nine-seven"
"Linux"
],
"interval": "5m",
"enabled": true,
Expand Down Expand Up @@ -540,7 +547,20 @@ If processing of any rule fails, a partial error outputs the ID and/or name of t
],
"query": "event.kind:alert and not event.module:(endgame or endpoint)\n",
"throttle": "no_actions",
"actions": []
"actions": [],
"execution_summary": { <1>
"last_execution": {
"date": "2022-03-23T16:06:12.787Z",
"status": "partial failure",
"status_order": 20,
"message": "This rule attempted to query data from Elasticsearch indices listed in the \"Index pattern\" section of the rule definition, but no matching index was found.",
"metrics": {
"total_search_duration_ms": 135,
"total_indexing_duration_ms": 15,
"execution_gap_duration_s": 0,
}
}
}
}
],
"created": [],
Expand All @@ -554,3 +574,5 @@ If processing of any rule fails, a partial error outputs the ID and/or name of t
}
}
--------------------------------------------------

<1> dev:[] `execution_summary` is under development and its schema may change.
15 changes: 15 additions & 0 deletions docs/detections/api/rules/rules-api-find.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,25 @@ Example response:
]
}
],
"execution_summary": { <1>
"last_execution": {
"date": "2022-03-23T16:06:12.787Z",
"status": "partial failure",
"status_order": 20,
"message": "This rule attempted to query data from Elasticsearch indices listed in the \"Index pattern\" section of the rule definition, but no matching index was found.",
"metrics": {
"total_search_duration_ms": 135,
"total_indexing_duration_ms": 15,
"execution_gap_duration_s": 0,
}
}
},
"version": 1
},
...
]
}

--------------------------------------------------

<1> dev:[] `execution_summary` is under development and its schema may change.
15 changes: 15 additions & 0 deletions docs/detections/api/rules/rules-api-get.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,22 @@ Example response:
]
}
],
"execution_summary": { <1>
"last_execution": {
"date": "2022-03-23T16:06:12.787Z",
"status": "partial failure",
"status_order": 20,
"message": "This rule attempted to query data from Elasticsearch indices listed in the \"Index pattern\" section of the rule definition, but no matching index was found.",
"metrics": {
"total_search_duration_ms": 135,
"total_indexing_duration_ms": 15,
"execution_gap_duration_s": 0,
}
}
},
"version": 1
}

--------------------------------------------------

<1> dev:[] `execution_summary` is under development and its schema may change.
15 changes: 15 additions & 0 deletions docs/detections/api/rules/rules-api-update.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,21 @@ Example response:
]
}
],
"execution_summary": { <1>
"last_execution": {
"date": "2022-03-23T16:06:12.787Z",
"status": "partial failure",
"status_order": 20,
"message": "This rule attempted to query data from Elasticsearch indices listed in the \"Index pattern\" section of the rule definition, but no matching index was found.",
"metrics": {
"total_search_duration_ms": 135,
"total_indexing_duration_ms": 15,
"execution_gap_duration_s": 0,
}
}
},
"version": 2
}
--------------------------------------------------

<1> dev:[] `execution_summary` is under development and its schema may change.