Rule fields
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events.
Examples of data sources that would populate the rule fields include: network admission control platforms, network or host IDS/IPS, network firewalls, web application firewalls, url filters, endpoint detection and response (EDR) systems, etc.
| Field | Description | Level |
|---|---|---|
| rule.author | Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. type: keyword Note: This field should contain an array of values. example: ["Star-Lord"] |
extended |
| rule.category | A categorization value keyword used by the entity using the rule for detection of this event. type: keyword example: Attempted Information Leak |
extended |
| rule.description | The description of the rule generating the event. type: keyword example: Block requests to public DNS over HTTPS / TLS protocols |
extended |
| rule.id | A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. type: keyword example: 101 |
extended |
| rule.license | Name of the license under which the rule used to generate this event is made available. type: keyword example: Apache 2.0 |
extended |
| rule.name | The name of the rule or signature generating the event. type: keyword example: BLOCK_DNS_over_TLS |
extended |
| rule.reference | Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert. type: keyword example: https://en.wikipedia.org/wiki/DNS_over_TLS |
extended |
| rule.ruleset | Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. type: keyword example: Standard_Protocol_Filters |
extended |
| rule.uuid | A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. type: keyword example: 1100110011 |
extended |
| rule.version | The version / revision of the rule being used for analysis. type: keyword example: 1.1 |
extended |