Alert schema
The alert schema describes all the fields present in alert events.
Elastic Security stores alerts that have been generated by detection rules in hidden Elasticsearch indices. The index pattern is .alerts-security.alerts-<space-id->
.
Note
Users are advised NOT to use the _source
field in alert documents, but rather to use the fields
option in the search API to programmatically obtain the list of fields used in these documents. Learn more about retrieving selected fields from a search.
Note
The non-ECS fields listed below are beta and subject to change.
Alert field | Description |
---|---|
@timestamp | ECS field, represents the time when the alert was created or most recently updated. |
message | ECS field copied from the source document, if present, for custom query and indicator match rules. |
tags | ECS field copied from the source document, if present, for custom query and indicator match rules. |
labels | ECS field copied from the source document, if present, for custom query and indicator match rules. |
ecs.version | ECS mapping version of the alert. |
event.kind | ECS field, always |
event.category | ECS field, copied from the source document, if present, for custom query and indicator match rules. |
event.type | ECS field, copied from the source document, if present, for custom query and indicator match rules. |
event.outcome | ECS field, copied from the source document, if present, for custom query and indicator match rules. |
agent.* | ECS |
client.* | ECS |
cloud.* | ECS |
container.* | ECS |
data_stream.* | ECS Note These fields may be constant keywords in the source documents, but are copied into the alert documents as keywords. |
destination.* | ECS |
dll.* | ECS |
dns.* | ECS |
error.* | ECS |
event.* | ECS Note categorization fields above ( |
file.* | ECS |
group.* | ECS |
host.* | ECS |
http.* | ECS |
log.* | ECS |
network.* | ECS |
observer.* | ECS |
orchestrator.* | ECS |
organization.* | ECS |
package.* | ECS |
process.* | ECS |
registry.* | ECS |
related.* | ECS |
rule.* | ECS Note These fields are not related to the detection rule that generated the alert. |
server.* | ECS |
service.* | ECS |
source.* | ECS |
span.* | ECS |
threat.* | ECS |
tls.* | ECS |
trace.* | ECS |
transaction.* | ECS |
url.* | ECS |
user.* | ECS |
user_agent.* | ECS |
vulnerability.* | ECS |
kibana.alert.ancestors.* | Type: object |
kibana.alert.depth | Type: Long |
kibana.alert.new_terms | The value of the new term that generated this alert. Type: keyword |
kibana.alert.original_event.* | Type: object |
kibana.alert.original_time | The value copied from the source event ( Type: date |
kibana.alert.reason | Type: keyword |
kibana.alert.rule.author | The value of the Type: keyword |
kibana.alert.building_block_type | The value of Type: keyword |
kibana.alert.rule.created_at | The value of Type: date |
kibana.alert.rule.created_by | Type: keyword |
kibana.alert.rule.description | Type: keyword |
kibana.alert.rule.enabled | Type: keyword |
kibana.alert.rule.false_positives | Type: keyword |
kibana.alert.rule.from | Type: keyword |
kibana.alert.rule.uuid | Type: keyword |
kibana.alert.rule.immutable | Type: keyword |
kibana.alert.rule.interval | Type: keyword |
kibana.alert.rule.license | Type: keyword |
kibana.alert.rule.max_signals | Type: long |
kibana.alert.rule.name | Type: keyword |
kibana.alert.rule.note | Type: keyword |
kibana.alert.rule.references | Type: keyword |
kibana.alert.risk_score | Type: float |
kibana.alert.rule.rule_id | Type: keyword |
kibana.alert.rule.rule_name_override | Type: keyword |
kibana.alert.severity | Alert severity, populated by the Type: keyword |
kibana.alert.rule.tags | Type: keyword |
kibana.alert.rule.threat.* | Type: object |
kibana.alert.rule.timeline_id | Type: keyword |
kibana.alert.rule.timeline_title | Type: keyword |
kibana.alert.rule.timestamp_override | Type: keyword |
kibana.alert.rule.to | Type: keyword |
kibana.alert.rule.type | Type: keyword |
kibana.alert.rule.updated_at | Type: date |
kibana.alert.rule.updated_by | Type: keyword |
kibana.alert.rule.version | A number that represents a rule's version. Type: keyword |
kibana.alert.rule.revision | A number that gets incremented each time you edit a rule. Type: long |
kibana.alert.workflow_status | Type: keyword |
kibana.alert.workflow_status_updated_at | The timestamp of when the alert's status was last updated. Type: date |
kibana.alert.threshold_result.* | Type: object |
kibana.alert.group.id | Type: keyword |
kibana.alert.group.index | Type: integer |
kibana.alert.rule.parameters.index | Type: flattened |
kibana.alert.rule.parameters.language | Type: flattened |
kibana.alert.rule.parameters.query | Type: flattened |
kibana.alert.rule.parameters.risk_score_mapping | Type: flattened |
kibana.alert.rule.parameters.saved_id | Type: flattened |
kibana.alert.rule.parameters.severity_mapping | Type: flattened |
kibana.alert.rule.parameters.threat_filters | Type: flattened |
kibana.alert.rule.parameters.threat_index | Names of the indicator indices. Type: flattened |
kibana.alert.rule.parameters.threat_indicator_path | Type: flattened |
kibana.alert.rule.parameters.threat_language | Type: flattened |
kibana.alert.rule.parameters.threat_mapping.* | Controls which fields will be compared in the indicator and source documents. Type: flattened |
kibana.alert.rule.parameters.threat_query | Type: flattened |
kibana.alert.rule.parameters.threshold.* | Type: flattened |
kibana.space_ids | Type: keyword |
kibana.alert.rule.consumer | Type: keyword |
kibana.alert.status | Type: keyword |
kibana.alert.rule.category | Type: keyword |
kibana.alert.rule.execution.uuid | Type: keyword |
kibana.alert.rule.producer | Type: keyword |
kibana.alert.rule.rule_type_id | Type: keyword |
kibana.alert.suppression.terms.field | The fields used to group alerts for suppression. Type: keyword |
kibana.alert.suppression.terms.value | The values in the suppression fields. Type: keyword |
kibana.alert.suppression.start | The timestamp of the first document in the suppression group. Type: date |
kibana.alert.suppression.end | The timestamp of the last document in the suppression group. Type: date |
kibana.alert.suppression.docs_count | The number of suppressed alerts. Type: long |
kibana.alert.url | The shareable URL for the alert. Note This field only appears if you've set the Type: long |
kibana.alert.workflow_tags | List of tags added to an alert. This field can contain an array of values, for example: Type: keyword |
kibana.alert.workflow_assignee_ids | List of users assigned to an alert. An array of unique identifiers (UIDs) for user profiles, for example: UIDs are linked to user profiles that are automatically created when users first log into a project. These profiles contain names, emails, profile avatars, and other user settings. Type: string[] |