diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index d61f39e197..aedfb866e6 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -38,6 +38,7 @@ Thanks, you're awesome :-) --> #### Breaking changes * Changed the order and column names in the csv. #621 +* Removed the file `schema.json` and the code generating it. #627 #### Bugfixes diff --git a/Makefile b/Makefile index bd5dd92873..02700dfe1c 100644 --- a/Makefile +++ b/Makefile @@ -30,8 +30,7 @@ check-license-headers: # Clean deletes all temporary and generated content. .PHONY: clean clean: - rm -rf schema.json build - rm -rf generated/legacy/template.json + rm -rf build generated/legacy/template.json # Clean all markdown files for use-cases find ./use-cases -type f -name '*.md' -not -name 'README.md' -print0 | xargs -0 rm -- @@ -56,7 +55,7 @@ fmt: ve # Alias to generate everything. .PHONY: generate -generate: template legacy_use_cases codegen generator schema.json +generate: template legacy_use_cases codegen generator # Run the new generator .PHONY: generator @@ -94,11 +93,6 @@ misspell: .PHONY: reload_docs reload_docs: generator docs -# Generate schema.json. -.PHONY: schema.json -schema.json: ve - $(PYTHON) scripts/schemas.py - # Download and setup tooling dependencies. .PHONY: setup setup: ve diff --git a/schema.json b/schema.json deleted file mode 100644 index bd38bb3e51..0000000000 --- a/schema.json +++ /dev/null @@ -1,3637 +0,0 @@ -{ - "agent": { - "description": "The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host.\nExamples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken.\n", - "fields": { - "agent.ephemeral_id": { - "description": "Ephemeral identifier of this agent (if one exists).\nThis id normally changes across restarts, but `agent.id` does not.", - "example": "8a4f500f", - "footnote": "", - "group": 2, - "level": "extended", - "name": "agent.ephemeral_id", - "required": false, - "type": "keyword" - }, - "agent.id": { - "description": "Unique identifier of this agent (if one exists).\nExample: For Beats this would be beat.id.", - "example": "8a4f500d", - "footnote": "", - "group": 2, - "level": "core", - "name": "agent.id", - "required": false, - "type": "keyword" - }, - "agent.name": { - "description": "Custom name of the agent.\nThis is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from.\nIf no name is given, the name is often left empty.", - "example": "foo", - "footnote": "", - "group": 2, - "level": "core", - "name": "agent.name", - "required": false, - "type": "keyword" - }, - "agent.type": { - "description": "Type of the agent.\nThe agent type stays always the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine.", - "example": "filebeat", - "footnote": "", - "group": 2, - "level": "core", - "name": "agent.type", - "required": false, - "type": "keyword" - }, - "agent.version": { - "description": "Version of the agent.", - "example": "6.0.0-rc2", - "footnote": "", - "group": 2, - "level": "core", - "name": "agent.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "agent", - "title": "Agent", - "type": "group" - }, - "as": { - "description": "An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.\n", - "fields": { - "as.number": { - "description": "Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.", - "example": "15169", - "footnote": "", - "group": 2, - "level": "extended", - "name": "as.number", - "required": false, - "type": "long" - }, - "as.organization.name": { - "description": "Organization name.", - "example": "Google LLC", - "footnote": "", - "group": 2, - "level": "extended", - "name": "as.organization.name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "as", - "title": "Autonomous System", - "type": "group" - }, - "base": { - "description": "The `base` field set contains all fields which are on the top level. These fields are common across all types of events.\n", - "fields": { - "@timestamp": { - "description": "Date/time when the event originated.\nThis is the date/time extracted from the event, typically representing when the event was generated by the source.\nIf the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline.\nRequired field for all events.", - "example": "2016-05-23T08:05:34.853Z", - "footnote": "", - "group": 1, - "level": "core", - "name": "@timestamp", - "required": true, - "type": "date" - }, - "labels": { - "description": "Custom key/value pairs.\nCan be used to add meta information to events. Should not contain nested objects. All values are stored as keyword.\nExample: `docker` and `k8s` labels.", - "example": "{'application': 'foo-bar', 'env': 'production'}", - "footnote": "", - "group": 1, - "level": "core", - "name": "labels", - "required": false, - "type": "object" - }, - "message": { - "description": "For log events the message field contains the log message, optimized for viewing in a log viewer.\nFor structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event.\nIf multiple messages exist, they can be combined into one message.", - "example": "Hello World", - "footnote": "", - "group": 1, - "level": "core", - "name": "message", - "required": false, - "type": "text" - }, - "tags": { - "description": "List of keywords used to tag each event.", - "example": "[\"production\", \"env2\"]", - "footnote": "", - "group": 1, - "level": "core", - "name": "tags", - "required": false, - "type": "keyword" - } - }, - "group": 1, - "name": "base", - "title": "Base", - "type": "group" - }, - "client": { - "description": "A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records.\nFor TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term \"originator\" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.\nClient / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.\n", - "fields": { - "client.address": { - "description": "Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.\nThen it should be duplicated to `.ip` or `.domain`, depending on which one it is.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "client.address", - "required": false, - "type": "keyword" - }, - "client.bytes": { - "description": "Bytes sent from the client to the server.", - "example": "184", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.bytes", - "required": false, - "type": "long" - }, - "client.domain": { - "description": "Client domain.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.domain", - "required": false, - "type": "keyword" - }, - "client.ip": { - "description": "IP address of the client.\nCan be one or multiple IPv4 or IPv6 addresses.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.ip", - "required": false, - "type": "ip" - }, - "client.mac": { - "description": "MAC address of the client.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.mac", - "required": false, - "type": "keyword" - }, - "client.nat.ip": { - "description": "Translated IP of source based NAT sessions (e.g. internal client to internet).\nTypically connections traversing load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "client.nat.ip", - "required": false, - "type": "ip" - }, - "client.nat.port": { - "description": "Translated port of source based NAT sessions (e.g. internal client to internet).\nTypically connections traversing load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "client.nat.port", - "required": false, - "type": "long" - }, - "client.packets": { - "description": "Packets sent from the client to the server.", - "example": "12", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.packets", - "required": false, - "type": "long" - }, - "client.port": { - "description": "Port of the client.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "client.port", - "required": false, - "type": "long" - }, - "client.registered_domain": { - "description": "The highest registered client domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "client.registered_domain", - "required": false, - "type": "keyword" - }, - "client.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "client.top_level_domain", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "client", - "title": "Client", - "type": "group" - }, - "cloud": { - "description": "Fields related to the cloud or infrastructure the events are coming from.\n", - "fields": { - "cloud.account.id": { - "description": "The cloud account or organization id used to identify different entities in a multi-tenant environment.\nExamples: AWS account id, Google Cloud ORG Id, or other unique identifier.", - "example": "666777888999", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.account.id", - "required": false, - "type": "keyword" - }, - "cloud.availability_zone": { - "description": "Availability zone in which this host is running.", - "example": "us-east-1c", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.availability_zone", - "required": false, - "type": "keyword" - }, - "cloud.instance.id": { - "description": "Instance ID of the host machine.", - "example": "i-1234567890abcdef0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.instance.id", - "required": false, - "type": "keyword" - }, - "cloud.instance.name": { - "description": "Instance name of the host machine.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.instance.name", - "required": false, - "type": "keyword" - }, - "cloud.machine.type": { - "description": "Machine type of the host machine.", - "example": "t2.medium", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.machine.type", - "required": false, - "type": "keyword" - }, - "cloud.provider": { - "description": "Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.", - "example": "aws", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.provider", - "required": false, - "type": "keyword" - }, - "cloud.region": { - "description": "Region in which this host is running.", - "example": "us-east-1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "cloud.region", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "cloud", - "title": "Cloud", - "type": "group" - }, - "container": { - "description": "Container fields are used for meta information about the specific container that is the source of information.\nThese fields help correlate data based containers from any runtime.\n", - "fields": { - "container.id": { - "description": "Unique container id.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "container.id", - "required": false, - "type": "keyword" - }, - "container.image.name": { - "description": "Name of the image the container was built on.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "container.image.name", - "required": false, - "type": "keyword" - }, - "container.image.tag": { - "description": "Container image tag.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "container.image.tag", - "required": false, - "type": "keyword" - }, - "container.labels": { - "description": "Image labels.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "container.labels", - "required": false, - "type": "object" - }, - "container.name": { - "description": "Container name.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "container.name", - "required": false, - "type": "keyword" - }, - "container.runtime": { - "description": "Runtime managing this container.", - "example": "docker", - "footnote": "", - "group": 2, - "level": "extended", - "name": "container.runtime", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "container", - "title": "Container", - "type": "group" - }, - "destination": { - "description": "Destination fields describe details about the destination of a packet/event.\nDestination fields are usually populated in conjunction with source fields.\n", - "fields": { - "destination.address": { - "description": "Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.\nThen it should be duplicated to `.ip` or `.domain`, depending on which one it is.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "destination.address", - "required": false, - "type": "keyword" - }, - "destination.bytes": { - "description": "Bytes sent from the destination to the source.", - "example": "184", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.bytes", - "required": false, - "type": "long" - }, - "destination.domain": { - "description": "Destination domain.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.domain", - "required": false, - "type": "keyword" - }, - "destination.ip": { - "description": "IP address of the destination.\nCan be one or multiple IPv4 or IPv6 addresses.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.ip", - "required": false, - "type": "ip" - }, - "destination.mac": { - "description": "MAC address of the destination.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.mac", - "required": false, - "type": "keyword" - }, - "destination.nat.ip": { - "description": "Translated ip of destination based NAT sessions (e.g. internet to private DMZ)\nTypically used with load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "destination.nat.ip", - "required": false, - "type": "ip" - }, - "destination.nat.port": { - "description": "Port the source session is translated to by NAT Device.\nTypically used with load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "destination.nat.port", - "required": false, - "type": "long" - }, - "destination.packets": { - "description": "Packets sent from the destination to the source.", - "example": "12", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.packets", - "required": false, - "type": "long" - }, - "destination.port": { - "description": "Port of the destination.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "destination.port", - "required": false, - "type": "long" - }, - "destination.registered_domain": { - "description": "The highest registered destination domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "destination.registered_domain", - "required": false, - "type": "keyword" - }, - "destination.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "destination.top_level_domain", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "destination", - "title": "Destination", - "type": "group" - }, - "dns": { - "description": "Fields describing DNS queries and answers.\nDNS events should either represent a single DNS query prior to getting answers (`dns.type:query`) or they should represent a full exchange and contain the query details as well as all of the answers that were provided for this query (`dns.type:answer`).\n", - "fields": { - "dns.answers": { - "description": "An array containing an object for each answer section returned by the server.\nThe main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines.\nNot all DNS data sources give all details about DNS answers. At minimum, answer objects must contain the `data` key. If more information is available, map as much of it to ECS as possible, and add any additional fields to the answer objects as custom fields.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers", - "required": false, - "type": "object" - }, - "dns.answers.class": { - "description": "The class of DNS data contained in this resource record.", - "example": "IN", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers.class", - "required": false, - "type": "keyword" - }, - "dns.answers.data": { - "description": "The data describing the resource.\nThe meaning of this data depends on the type and class of the resource record.", - "example": "10.10.10.10", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers.data", - "required": false, - "type": "keyword" - }, - "dns.answers.name": { - "description": "The domain name to which this resource record pertains.\nIf a chain of CNAME is being resolved, each answer's `name` should be the one that corresponds with the answer's `data`. It should not simply be the original `question.name` repeated.", - "example": "www.google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers.name", - "required": false, - "type": "keyword" - }, - "dns.answers.ttl": { - "description": "The time interval in seconds that this resource record may be cached before it should be discarded. Zero values mean that the data should not be cached.", - "example": "180", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers.ttl", - "required": false, - "type": "long" - }, - "dns.answers.type": { - "description": "The type of data contained in this resource record.", - "example": "CNAME", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.answers.type", - "required": false, - "type": "keyword" - }, - "dns.header_flags": { - "description": "Array of 2 letter DNS header flags.\nExpected values are: AA, TC, RD, RA, AD, CD, DO.", - "example": "['RD', 'RA']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.header_flags", - "required": false, - "type": "keyword" - }, - "dns.id": { - "description": "The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response.", - "example": "62111", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.id", - "required": false, - "type": "keyword" - }, - "dns.op_code": { - "description": "The DNS operation code that specifies the kind of query in the message. This value is set by the originator of a query and copied into the response.", - "example": "QUERY", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.op_code", - "required": false, - "type": "keyword" - }, - "dns.question.class": { - "description": "The class of of records being queried.", - "example": "IN", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.class", - "required": false, - "type": "keyword" - }, - "dns.question.name": { - "description": "The name being queried.\nIf the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \\t, \\r, and \\n respectively.", - "example": "www.google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.name", - "required": false, - "type": "keyword" - }, - "dns.question.registered_domain": { - "description": "The highest registered domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.registered_domain", - "required": false, - "type": "keyword" - }, - "dns.question.subdomain": { - "description": "The subdomain is all of the labels under the registered_domain.\nIf the domain has multiple levels of subdomain, such as \"sub2.sub1.example.com\", the subdomain field should contain \"sub2.sub1\", with no trailing period.", - "example": "www", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.subdomain", - "required": false, - "type": "keyword" - }, - "dns.question.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.top_level_domain", - "required": false, - "type": "keyword" - }, - "dns.question.type": { - "description": "The type of record being queried.", - "example": "AAAA", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.question.type", - "required": false, - "type": "keyword" - }, - "dns.resolved_ip": { - "description": "Array containing all IPs seen in `answers.data`.\nThe `answers` array can be difficult to use, because of the variety of data formats it can contain. Extracting all IP addresses seen in there to `dns.resolved_ip` makes it possible to index them as IP addresses, and makes them easier to visualize and query for.", - "example": "['10.10.10.10', '10.10.10.11']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.resolved_ip", - "required": false, - "type": "ip" - }, - "dns.response_code": { - "description": "The DNS response code.", - "example": "NOERROR", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.response_code", - "required": false, - "type": "keyword" - }, - "dns.type": { - "description": "The type of DNS event captured, query or answer.\nIf your source of DNS events only gives you DNS queries, you should only create dns events of type `dns.type:query`.\nIf your source of DNS events gives you answers as well, you should create one event per query (optionally as soon as the query is seen). And a second event containing all query details as well as an array of answers.", - "example": "answer", - "footnote": "", - "group": 2, - "level": "extended", - "name": "dns.type", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "dns", - "title": "DNS", - "type": "group" - }, - "ecs": { - "description": "Meta-information specific to ECS.\n", - "fields": { - "ecs.version": { - "description": "ECS version this event conforms to. `ecs.version` is a required field and must exist in all events.\nWhen querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.", - "example": "1.0.0", - "footnote": "", - "group": 2, - "level": "core", - "name": "ecs.version", - "required": true, - "type": "keyword" - } - }, - "group": 2, - "name": "ecs", - "title": "ECS", - "type": "group" - }, - "error": { - "description": "These fields can represent errors of any kind.\nUse them for errors that happen while fetching events or in cases where the event itself contains an error.\n", - "fields": { - "error.code": { - "description": "Error code describing the error.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "error.code", - "required": false, - "type": "keyword" - }, - "error.id": { - "description": "Unique identifier for the error.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "error.id", - "required": false, - "type": "keyword" - }, - "error.message": { - "description": "Error message.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "error.message", - "required": false, - "type": "text" - }, - "error.stack_trace": { - "description": "The stack trace of this error in plain text.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "error.stack_trace", - "required": false, - "type": "(not indexed)" - }, - "error.type": { - "description": "The type of the error, for example the class name of the exception.", - "example": "java.lang.NullPointerException", - "footnote": "", - "group": 2, - "level": "extended", - "name": "error.type", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "error", - "title": "Error", - "type": "group" - }, - "event": { - "description": "The event fields are used for context information about the log or metric event itself.\nA log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical or categorical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host, or vulnerabilities measured on a scanned host.\n", - "fields": { - "event.action": { - "description": "The action captured by the event.\nThis describes the information in the event. It is more specific than `event.category`. Examples are `group-add`, `process-started`, `file-created`. The value is normally defined by the implementer.", - "example": "user-password-change", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.action", - "required": false, - "type": "keyword" - }, - "event.category": { - "description": "Event category.\nThis contains high-level information about the contents of the event. It is more generic than `event.action`, in the sense that typically a category contains multiple actions. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.", - "example": "user-management", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.category", - "required": false, - "type": "keyword" - }, - "event.code": { - "description": "Identification code for this event, if one exists.\nSome event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID.", - "example": "4648", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.code", - "required": false, - "type": "keyword" - }, - "event.created": { - "description": "event.created contains the date/time when the event was first read by an agent, or by your pipeline.\nThis field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event.\nIn most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent's or pipeline's ability to keep up with your event source.\nIn case the two timestamps are identical, @timestamp should be used.", - "example": "2016-05-23 08:05:34.857000", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.created", - "required": false, - "type": "date" - }, - "event.dataset": { - "description": "Name of the dataset.\nIf an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from.\nIt's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.", - "example": "apache.access", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.dataset", - "required": false, - "type": "keyword" - }, - "event.duration": { - "description": "Duration of the event in nanoseconds.\nIf event.start and event.end are known this value should be the difference between the end and start time.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.duration", - "required": false, - "type": "long" - }, - "event.end": { - "description": "event.end contains the date when the event ended or when the activity was last observed.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.end", - "required": false, - "type": "date" - }, - "event.hash": { - "description": "Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.", - "example": "123456789012345678901234567890ABCD", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.hash", - "required": false, - "type": "keyword" - }, - "event.id": { - "description": "Unique ID to describe the event.", - "example": "8a4f500d", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.id", - "required": false, - "type": "keyword" - }, - "event.ingested": { - "description": "Timestamp when an event arrived in the central data store.\nThis is different from `@timestamp`, which is when the event originally occurred. It's also different from `event.created`, which is meant to capture the first time an agent saw the event.\nIn normal conditions, assuming no tampering, the timestamps should chronologically look like this: `@timestamp` < `event.created` < `event.ingested`.", - "example": "2016-05-23 08:05:35.101000", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.ingested", - "required": false, - "type": "date" - }, - "event.kind": { - "description": "The kind of the event.\nThis gives information about what type of information the event contains, without being specific to the contents of the event. Examples are `event`, `state`, `alarm`. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.", - "example": "state", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.kind", - "required": false, - "type": "keyword" - }, - "event.module": { - "description": "Name of the module this data is coming from.\nIf your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), `event.module` should contain the name of this module.", - "example": "apache", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.module", - "required": false, - "type": "keyword" - }, - "event.original": { - "description": "Raw text message of entire event. Used to demonstrate log integrity.\nThis field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from `_source`.", - "example": "Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0|100| worm successfully stopped|10|src=10.0.0.1 dst=2.1.2.2spt=1232", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.original", - "required": false, - "type": "(not indexed)" - }, - "event.outcome": { - "description": "The outcome of the event.\nIf the event describes an action, this fields contains the outcome of that action. Examples outcomes are `success` and `failure`. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.", - "example": "success", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.outcome", - "required": false, - "type": "keyword" - }, - "event.provider": { - "description": "Source of the event.\nEvent transports such as Syslog or the Windows Event Log typically mention the source of an event. It can be the name of the software that generated the event (e.g. Sysmon, httpd), or of a subsystem of the operating system (kernel, Microsoft-Windows-Security-Auditing).", - "example": "kernel", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.provider", - "required": false, - "type": "keyword" - }, - "event.risk_score": { - "description": "Risk score or priority of the event (e.g. security solutions). Use your system's original value here.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.risk_score", - "required": false, - "type": "float" - }, - "event.risk_score_norm": { - "description": "Normalized risk score or priority of the event, on a scale of 0 to 100.\nThis is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.risk_score_norm", - "required": false, - "type": "float" - }, - "event.sequence": { - "description": "Sequence number of the event.\nThe sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regarless of the timestamp precision.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.sequence", - "required": false, - "type": "long" - }, - "event.severity": { - "description": "The numeric severity of the event according to your event source.\nWhat the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source.\nThe Syslog severity belongs in `log.syslog.severity.code`. `event.severity` is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the `log.syslog.severity.code` to `event.severity`.", - "example": "7", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.severity", - "required": false, - "type": "long" - }, - "event.start": { - "description": "event.start contains the date when the event started or when the activity was first observed.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.start", - "required": false, - "type": "date" - }, - "event.timezone": { - "description": "This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise.\nAcceptable timezone formats are: a canonical ID (e.g. \"Europe/Amsterdam\"), abbreviated (e.g. \"EST\") or an HH:mm differential (e.g. \"-05:00\").", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "event.timezone", - "required": false, - "type": "keyword" - }, - "event.type": { - "description": "Reserved for future usage.\nPlease avoid using this field for user data.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "event.type", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "event", - "title": "Event", - "type": "group" - }, - "file": { - "description": "A file is defined as a set of information that has been created on, or has existed on a filesystem.\nFile objects can be associated with host events, network events, and/or file events (e.g., those produced by File Integrity Monitoring [FIM] products or services). File fields provide details about the affected file associated with the event or metric.\n", - "fields": { - "file.accessed": { - "description": "Last time the file was accessed.\nNote that not all filesystems keep track of access time.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.accessed", - "required": false, - "type": "date" - }, - "file.created": { - "description": "File creation time.\nNote that not all filesystems store the creation time.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.created", - "required": false, - "type": "date" - }, - "file.ctime": { - "description": "Last time the file attributes or metadata changed.\nNote that changes to the file content will update `mtime`. This implies `ctime` will be adjusted at the same time, since `mtime` is an attribute of the file.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.ctime", - "required": false, - "type": "date" - }, - "file.device": { - "description": "Device that is the source of the file.", - "example": "sda", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.device", - "required": false, - "type": "keyword" - }, - "file.directory": { - "description": "Directory where the file is located.", - "example": "/home/alice", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.directory", - "required": false, - "type": "keyword" - }, - "file.extension": { - "description": "File extension.", - "example": "png", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.extension", - "required": false, - "type": "keyword" - }, - "file.gid": { - "description": "Primary group ID (GID) of the file.", - "example": "1001", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.gid", - "required": false, - "type": "keyword" - }, - "file.group": { - "description": "Primary group name of the file.", - "example": "alice", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.group", - "required": false, - "type": "keyword" - }, - "file.inode": { - "description": "Inode representing the file in the filesystem.", - "example": "256383", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.inode", - "required": false, - "type": "keyword" - }, - "file.mode": { - "description": "Mode of the file in octal representation.", - "example": "0640", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.mode", - "required": false, - "type": "keyword" - }, - "file.mtime": { - "description": "Last time the file content was modified.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.mtime", - "required": false, - "type": "date" - }, - "file.name": { - "description": "Name of the file including the extension, without the directory.", - "example": "example.png", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.name", - "required": false, - "type": "keyword" - }, - "file.owner": { - "description": "File owner's username.", - "example": "alice", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.owner", - "required": false, - "type": "keyword" - }, - "file.path": { - "description": "Full path to the file.", - "example": "/home/alice/example.png", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.path", - "required": false, - "type": "keyword" - }, - "file.size": { - "description": "File size in bytes.\nOnly relevant when `file.type` is \"file\".", - "example": "16384", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.size", - "required": false, - "type": "long" - }, - "file.target_path": { - "description": "Target path for symlinks.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.target_path", - "required": false, - "type": "keyword" - }, - "file.type": { - "description": "File type (file, dir, or symlink).", - "example": "file", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.type", - "required": false, - "type": "keyword" - }, - "file.uid": { - "description": "The user ID (UID) or security identifier (SID) of the file owner.", - "example": "1001", - "footnote": "", - "group": 2, - "level": "extended", - "name": "file.uid", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "file", - "title": "File", - "type": "group" - }, - "geo": { - "description": "Geo fields can carry data about a specific location related to an event.\nThis geolocation information can be derived from techniques such as Geo IP, or be user-supplied.\n", - "fields": { - "geo.city_name": { - "description": "City name.", - "example": "Montreal", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.city_name", - "required": false, - "type": "keyword" - }, - "geo.continent_name": { - "description": "Name of the continent.", - "example": "North America", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.continent_name", - "required": false, - "type": "keyword" - }, - "geo.country_iso_code": { - "description": "Country ISO code.", - "example": "CA", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.country_iso_code", - "required": false, - "type": "keyword" - }, - "geo.country_name": { - "description": "Country name.", - "example": "Canada", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.country_name", - "required": false, - "type": "keyword" - }, - "geo.location": { - "description": "Longitude and latitude.", - "example": "{ \"lon\": -73.614830, \"lat\": 45.505918 }", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.location", - "required": false, - "type": "geo_point" - }, - "geo.name": { - "description": "User-defined description of a location, at the level of granularity they care about.\nCould be the name of their data centers, the floor number, if this describes a local physical entity, city names.\nNot typically used in automated geolocation.", - "example": "boston-dc", - "footnote": "", - "group": 2, - "level": "extended", - "name": "geo.name", - "required": false, - "type": "keyword" - }, - "geo.region_iso_code": { - "description": "Region ISO code.", - "example": "CA-QC", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.region_iso_code", - "required": false, - "type": "keyword" - }, - "geo.region_name": { - "description": "Region name.", - "example": "Quebec", - "footnote": "", - "group": 2, - "level": "core", - "name": "geo.region_name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "geo", - "title": "Geo", - "type": "group" - }, - "group": { - "description": "The group fields are meant to represent groups that are relevant to the event.\n", - "fields": { - "group.domain": { - "description": "Name of the directory the group is a member of.\nFor example, an LDAP or Active Directory domain name.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "group.domain", - "required": false, - "type": "keyword" - }, - "group.id": { - "description": "Unique identifier for the group on the system/platform.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "group.id", - "required": false, - "type": "keyword" - }, - "group.name": { - "description": "Name of the group.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "group.name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "group", - "title": "Group", - "type": "group" - }, - "hash": { - "description": "The hash fields represent different hash algorithms and their values.\nField names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512).\n", - "fields": { - "hash.md5": { - "description": "MD5 hash.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "hash.md5", - "required": false, - "type": "keyword" - }, - "hash.sha1": { - "description": "SHA1 hash.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "hash.sha1", - "required": false, - "type": "keyword" - }, - "hash.sha256": { - "description": "SHA256 hash.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "hash.sha256", - "required": false, - "type": "keyword" - }, - "hash.sha512": { - "description": "SHA512 hash.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "hash.sha512", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "hash", - "title": "Hash", - "type": "group" - }, - "host": { - "description": "A host is defined as a general computing instance.\nECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.\n", - "fields": { - "host.architecture": { - "description": "Operating system architecture.", - "example": "x86_64", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.architecture", - "required": false, - "type": "keyword" - }, - "host.domain": { - "description": "Name of the domain of which the host is a member. \nFor example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider.", - "example": "CONTOSO", - "footnote": "", - "group": 2, - "level": "extended", - "name": "host.domain", - "required": false, - "type": "keyword" - }, - "host.hostname": { - "description": "Hostname of the host.\nIt normally contains what the `hostname` command returns on the host machine.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.hostname", - "required": false, - "type": "keyword" - }, - "host.id": { - "description": "Unique host id.\nAs hostname is not always unique, use values that are meaningful in your environment.\nExample: The current usage of `beat.name`.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.id", - "required": false, - "type": "keyword" - }, - "host.ip": { - "description": "Host ip address.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.ip", - "required": false, - "type": "ip" - }, - "host.mac": { - "description": "Host mac address.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.mac", - "required": false, - "type": "keyword" - }, - "host.name": { - "description": "Name of the host.\nIt can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.name", - "required": false, - "type": "keyword" - }, - "host.type": { - "description": "Type of host.\nFor Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "host.type", - "required": false, - "type": "keyword" - }, - "host.uptime": { - "description": "Seconds the host has been up.", - "example": "1325", - "footnote": "", - "group": 2, - "level": "extended", - "name": "host.uptime", - "required": false, - "type": "long" - } - }, - "group": 2, - "name": "host", - "title": "Host", - "type": "group" - }, - "http": { - "description": "Fields related to HTTP activity. Use the `url` field set to store the url of the request.\n", - "fields": { - "http.request.body.bytes": { - "description": "Size in bytes of the request body.", - "example": "887", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.request.body.bytes", - "required": false, - "type": "long" - }, - "http.request.body.content": { - "description": "The full HTTP request body.", - "example": "Hello world", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.request.body.content", - "required": false, - "type": "keyword" - }, - "http.request.bytes": { - "description": "Total size in bytes of the request (body and headers).", - "example": "1437", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.request.bytes", - "required": false, - "type": "long" - }, - "http.request.method": { - "description": "HTTP request method.\nThe field value must be normalized to lowercase for querying. See the documentation section \"Implementing ECS\".", - "example": "get, post, put", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.request.method", - "required": false, - "type": "keyword" - }, - "http.request.referrer": { - "description": "Referrer for this HTTP request.", - "example": "https://blog.example.com/", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.request.referrer", - "required": false, - "type": "keyword" - }, - "http.response.body.bytes": { - "description": "Size in bytes of the response body.", - "example": "887", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.response.body.bytes", - "required": false, - "type": "long" - }, - "http.response.body.content": { - "description": "The full HTTP response body.", - "example": "Hello world", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.response.body.content", - "required": false, - "type": "keyword" - }, - "http.response.bytes": { - "description": "Total size in bytes of the response (body and headers).", - "example": "1437", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.response.bytes", - "required": false, - "type": "long" - }, - "http.response.status_code": { - "description": "HTTP response status code.", - "example": "404", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.response.status_code", - "required": false, - "type": "long" - }, - "http.version": { - "description": "HTTP version.", - "example": "1.1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "http.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "http", - "title": "HTTP", - "type": "group" - }, - "log": { - "description": "Details about the event's logging mechanism or logging transport.\nThe log.* fields are typically populated with details about the logging mechanism used to create and/or transport the event. For example, syslog details belong under `log.syslog.*`.\nThe details specific to your event source are typically not logged under `log.*`, but rather in `event.*` or in other ECS fields.\n", - "fields": { - "log.level": { - "description": "Original log level of the log event.\nIf the source of the event provides a log level or textual severity, this is the one that goes in `log.level`. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity).\nSome examples are `warn`, `err`, `i`, `informational`.", - "example": "error", - "footnote": "", - "group": 2, - "level": "core", - "name": "log.level", - "required": false, - "type": "keyword" - }, - "log.logger": { - "description": "The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name.", - "example": "org.elasticsearch.bootstrap.Bootstrap", - "footnote": "", - "group": 2, - "level": "core", - "name": "log.logger", - "required": false, - "type": "keyword" - }, - "log.origin.file.line": { - "description": "The line number of the file containing the source code which originated the log event.", - "example": "42", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.origin.file.line", - "required": false, - "type": "integer" - }, - "log.origin.file.name": { - "description": "The name of the file containing the source code which originated the log event. Note that this is not the name of the log file.", - "example": "Bootstrap.java", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.origin.file.name", - "required": false, - "type": "keyword" - }, - "log.origin.function": { - "description": "The name of the function or method which originated the log event.", - "example": "init", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.origin.function", - "required": false, - "type": "keyword" - }, - "log.original": { - "description": "This is the original log message and contains the full log message before splitting it up in multiple parts.\nIn contrast to the `message` field which can contain an extracted part of the log message, this field contains the original, full log message. It can have already some modifications applied like encoding or new lines removed to clean up the log message.\nThis field is not indexed and doc_values are disabled so it can't be queried but the value can be retrieved from `_source`.", - "example": "Sep 19 08:26:10 localhost My log", - "footnote": "", - "group": 2, - "level": "core", - "name": "log.original", - "required": false, - "type": "(not indexed)" - }, - "log.syslog": { - "description": "The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog", - "required": false, - "type": "object" - }, - "log.syslog.facility.code": { - "description": "The Syslog numeric facility of the log event, if available.\nAccording to RFCs 5424 and 3164, this value should be an integer between 0 and 23.", - "example": "23", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog.facility.code", - "required": false, - "type": "long" - }, - "log.syslog.facility.name": { - "description": "The Syslog text-based facility of the log event, if available.", - "example": "local7", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog.facility.name", - "required": false, - "type": "keyword" - }, - "log.syslog.priority": { - "description": "Syslog numeric priority of the event, if available.\nAccording to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191.", - "example": "135", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog.priority", - "required": false, - "type": "long" - }, - "log.syslog.severity.code": { - "description": "The Syslog numeric severity of the log event, if available.\nIf the event source publishing via Syslog provides a different numeric severity value (e.g. firewall, IDS), your source's numeric severity should go to `event.severity`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `event.severity`.", - "example": "3", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog.severity.code", - "required": false, - "type": "long" - }, - "log.syslog.severity.name": { - "description": "The Syslog numeric severity of the log event, if available.\nIf the event source publishing via Syslog provides a different severity value (e.g. firewall, IDS), your source's text severity should go to `log.level`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `log.level`.", - "example": "Error", - "footnote": "", - "group": 2, - "level": "extended", - "name": "log.syslog.severity.name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "log", - "title": "Log", - "type": "group" - }, - "network": { - "description": "The network is defined as the communication path over which a host or network event happens.\nThe network.* fields should be populated with details about the network activity associated with an event.\n", - "fields": { - "network.application": { - "description": "A name given to an application level protocol. This can be arbitrarily assigned for things like microservices, but also apply to things like skype, icq, facebook, twitter. This would be used in situations where the vendor or service can be decoded such as from the source/dest IP owners, ports, or wire format.\nThe field value must be normalized to lowercase for querying. See the documentation section \"Implementing ECS\".", - "example": "aim", - "footnote": "", - "group": 2, - "level": "extended", - "name": "network.application", - "required": false, - "type": "keyword" - }, - "network.bytes": { - "description": "Total bytes transferred in both directions.\nIf `source.bytes` and `destination.bytes` are known, `network.bytes` is their sum.", - "example": "368", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.bytes", - "required": false, - "type": "long" - }, - "network.community_id": { - "description": "A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows.\nLearn more at https://github.com/corelight/community-id-spec.", - "example": "1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=", - "footnote": "", - "group": 2, - "level": "extended", - "name": "network.community_id", - "required": false, - "type": "keyword" - }, - "network.direction": { - "description": "Direction of the network traffic.\nRecommended values are:\n * inbound\n * outbound\n * internal\n * external\n * unknown\n\nWhen mapping events from a host-based monitoring context, populate this field from the host's point of view.\nWhen mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of your network perimeter.", - "example": "inbound", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.direction", - "required": false, - "type": "keyword" - }, - "network.forwarded_ip": { - "description": "Host IP address when the source IP address is the proxy.", - "example": "192.1.1.2", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.forwarded_ip", - "required": false, - "type": "ip" - }, - "network.iana_number": { - "description": "IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number.", - "example": "6", - "footnote": "", - "group": 2, - "level": "extended", - "name": "network.iana_number", - "required": false, - "type": "keyword" - }, - "network.name": { - "description": "Name given by operators to sections of their network.", - "example": "Guest Wifi", - "footnote": "", - "group": 2, - "level": "extended", - "name": "network.name", - "required": false, - "type": "keyword" - }, - "network.packets": { - "description": "Total packets transferred in both directions.\nIf `source.packets` and `destination.packets` are known, `network.packets` is their sum.", - "example": "24", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.packets", - "required": false, - "type": "long" - }, - "network.protocol": { - "description": "L7 Network protocol name. ex. http, lumberjack, transport protocol.\nThe field value must be normalized to lowercase for querying. See the documentation section \"Implementing ECS\".", - "example": "http", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.protocol", - "required": false, - "type": "keyword" - }, - "network.transport": { - "description": "Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.)\nThe field value must be normalized to lowercase for querying. See the documentation section \"Implementing ECS\".", - "example": "tcp", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.transport", - "required": false, - "type": "keyword" - }, - "network.type": { - "description": "In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc\nThe field value must be normalized to lowercase for querying. See the documentation section \"Implementing ECS\".", - "example": "ipv4", - "footnote": "", - "group": 2, - "level": "core", - "name": "network.type", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "network", - "title": "Network", - "type": "group" - }, - "observer": { - "description": "An observer is defined as a special network, security, or application device used to detect, observe, or create network, security, or application-related events and metrics.\nThis could be a custom hardware appliance or a server that has been configured to run special network, security, or application software. Examples include firewalls, web proxies, intrusion detection/prevention systems, network monitoring sensors, web application firewalls, data loss prevention systems, and APM servers. The observer.* fields shall be populated with details of the system, if any, that detects, observes and/or creates a network, security, or application event or metric. Message queues and ETL components used in processing events or metrics are not considered observers in ECS.\n", - "fields": { - "observer.hostname": { - "description": "Hostname of the observer.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.hostname", - "required": false, - "type": "keyword" - }, - "observer.ip": { - "description": "IP address of the observer.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.ip", - "required": false, - "type": "ip" - }, - "observer.mac": { - "description": "MAC address of the observer", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.mac", - "required": false, - "type": "keyword" - }, - "observer.name": { - "description": "Custom name of the observer.\nThis is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization.\nIf no custom name is needed, the field can be left empty.", - "example": "1_proxySG", - "footnote": "", - "group": 2, - "level": "extended", - "name": "observer.name", - "required": false, - "type": "keyword" - }, - "observer.product": { - "description": "The product name of the observer.", - "example": "s200", - "footnote": "", - "group": 2, - "level": "extended", - "name": "observer.product", - "required": false, - "type": "keyword" - }, - "observer.serial_number": { - "description": "Observer serial number.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "observer.serial_number", - "required": false, - "type": "keyword" - }, - "observer.type": { - "description": "The type of the observer the data is coming from.\nThere is no predefined list of observer types. Some examples are `forwarder`, `firewall`, `ids`, `ips`, `proxy`, `poller`, `sensor`, `APM server`.", - "example": "firewall", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.type", - "required": false, - "type": "keyword" - }, - "observer.vendor": { - "description": "Vendor name of the observer.", - "example": "Symantec", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.vendor", - "required": false, - "type": "keyword" - }, - "observer.version": { - "description": "Observer version.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "observer.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "observer", - "title": "Observer", - "type": "group" - }, - "organization": { - "description": "The organization fields enrich data with information about the company or entity the data is associated with.\nThese fields help you arrange or filter data stored in an index by one or multiple organizations.\n", - "fields": { - "organization.id": { - "description": "Unique identifier for the organization.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "organization.id", - "required": false, - "type": "keyword" - }, - "organization.name": { - "description": "Organization name.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "organization.name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "organization", - "title": "Organization", - "type": "group" - }, - "os": { - "description": "The OS fields contain information about the operating system.\n", - "fields": { - "os.family": { - "description": "OS family (such as redhat, debian, freebsd, windows).", - "example": "debian", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.family", - "required": false, - "type": "keyword" - }, - "os.full": { - "description": "Operating system name, including the version or code name.", - "example": "Mac OS Mojave", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.full", - "required": false, - "type": "keyword" - }, - "os.kernel": { - "description": "Operating system kernel version as a raw string.", - "example": "4.4.0-112-generic", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.kernel", - "required": false, - "type": "keyword" - }, - "os.name": { - "description": "Operating system name, without the version.", - "example": "Mac OS X", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.name", - "required": false, - "type": "keyword" - }, - "os.platform": { - "description": "Operating system platform (such centos, ubuntu, windows).", - "example": "darwin", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.platform", - "required": false, - "type": "keyword" - }, - "os.version": { - "description": "Operating system version as a raw string.", - "example": "10.14.1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "os.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "os", - "title": "Operating System", - "type": "group" - }, - "package": { - "description": "These fields contain information about an installed software package. It contains general information about a package, such as name, version or size. It also contains installation details, such as time or location.\n", - "fields": { - "package.architecture": { - "description": "Package architecture.", - "example": "x86_64", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.architecture", - "required": false, - "type": "keyword" - }, - "package.build_version": { - "description": "Additional information about the build version of the installed package.\nFor example use the commit SHA of a non-released package.", - "example": "36f4f7e89dd61b0988b12ee000b98966867710cd", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.build_version", - "required": false, - "type": "keyword" - }, - "package.checksum": { - "description": "Checksum of the installed package for verification.", - "example": "68b329da9893e34099c7d8ad5cb9c940", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.checksum", - "required": false, - "type": "keyword" - }, - "package.description": { - "description": "Description of the package.", - "example": "Open source programming language to build simple/reliable/efficient software.", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.description", - "required": false, - "type": "keyword" - }, - "package.install_scope": { - "description": "Indicating how the package was installed, e.g. user-local, global.", - "example": "global", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.install_scope", - "required": false, - "type": "keyword" - }, - "package.installed": { - "description": "Time when package was installed.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.installed", - "required": false, - "type": "date" - }, - "package.license": { - "description": "License under which the package was released.\nUse a short name, e.g. the license identifier from SPDX License List where possible (https://spdx.org/licenses/).", - "example": "Apache License 2.0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.license", - "required": false, - "type": "keyword" - }, - "package.name": { - "description": "Package name", - "example": "go", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.name", - "required": false, - "type": "keyword" - }, - "package.path": { - "description": "Path where the package is installed.", - "example": "/usr/local/Cellar/go/1.12.9/", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.path", - "required": false, - "type": "keyword" - }, - "package.reference": { - "description": "Home page or reference URL of the software in this package, if available.", - "example": "https://golang.org", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.reference", - "required": false, - "type": "keyword" - }, - "package.size": { - "description": "Package size in bytes.", - "example": "62231", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.size", - "required": false, - "type": "long" - }, - "package.type": { - "description": "Type of package.\nThis should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar.", - "example": "rpm", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.type", - "required": false, - "type": "keyword" - }, - "package.version": { - "description": "Package version", - "example": "1.12.9", - "footnote": "", - "group": 2, - "level": "extended", - "name": "package.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "package", - "title": "Package", - "type": "group" - }, - "process": { - "description": "These fields contain information about a process.\nThese fields can help you correlate metrics information with a process id/name from a log message. The `process.pid` often stays in the metric itself and is copied to the global field for correlation.\n", - "fields": { - "process.args": { - "description": "Array of process arguments, starting with the absolute path to the executable.\nMay be filtered to protect sensitive information.", - "example": "['/usr/bin/ssh', '-l', 'user', '10.0.0.16']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.args", - "required": false, - "type": "keyword" - }, - "process.args_count": { - "description": "Length of the process.args array.\nThis field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity.", - "example": "4", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.args_count", - "required": false, - "type": "long" - }, - "process.command_line": { - "description": "Full command line that started the process, including the absolute path to the executable, and all arguments.\nSome arguments may be filtered to protect sensitive information.", - "example": "/usr/bin/ssh -l user 10.0.0.16", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.command_line", - "required": false, - "type": "keyword" - }, - "process.executable": { - "description": "Absolute path to the process executable.", - "example": "/usr/bin/ssh", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.executable", - "required": false, - "type": "keyword" - }, - "process.exit_code": { - "description": "The exit code of the process, if this is a termination event.\nThe field should be absent if there is no exit code for the event (e.g. process start).", - "example": "137", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.exit_code", - "required": false, - "type": "long" - }, - "process.name": { - "description": "Process name.\nSometimes called program name or similar.", - "example": "ssh", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.name", - "required": false, - "type": "keyword" - }, - "process.parent.args": { - "description": "Array of process arguments.\nMay be filtered to protect sensitive information.", - "example": "['ssh', '-l', 'user', '10.0.0.16']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.args", - "required": false, - "type": "keyword" - }, - "process.parent.args_count": { - "description": "Length of the process.args array.\nThis field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity.", - "example": "4", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.args_count", - "required": false, - "type": "long" - }, - "process.parent.command_line": { - "description": "Full command line that started the process, including the absolute path to the executable, and all arguments.\nSome arguments may be filtered to protect sensitive information.", - "example": "/usr/bin/ssh -l user 10.0.0.16", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.command_line", - "required": false, - "type": "keyword" - }, - "process.parent.executable": { - "description": "Absolute path to the process executable.", - "example": "/usr/bin/ssh", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.executable", - "required": false, - "type": "keyword" - }, - "process.parent.exit_code": { - "description": "The exit code of the process, if this is a termination event.\nThe field should be absent if there is no exit code for the event (e.g. process start).", - "example": "137", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.exit_code", - "required": false, - "type": "long" - }, - "process.parent.name": { - "description": "Process name.\nSometimes called program name or similar.", - "example": "ssh", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.name", - "required": false, - "type": "keyword" - }, - "process.parent.pgid": { - "description": "Identifier of the group of processes the process belongs to.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.pgid", - "required": false, - "type": "long" - }, - "process.parent.pid": { - "description": "Process id.", - "example": "4242", - "footnote": "", - "group": 2, - "level": "core", - "name": "process.parent.pid", - "required": false, - "type": "long" - }, - "process.parent.ppid": { - "description": "Parent process' pid.", - "example": "4241", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.ppid", - "required": false, - "type": "long" - }, - "process.parent.start": { - "description": "The time the process started.", - "example": "2016-05-23T08:05:34.853Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.start", - "required": false, - "type": "date" - }, - "process.parent.thread.id": { - "description": "Thread ID.", - "example": "4242", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.thread.id", - "required": false, - "type": "long" - }, - "process.parent.thread.name": { - "description": "Thread name.", - "example": "thread-0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.thread.name", - "required": false, - "type": "keyword" - }, - "process.parent.title": { - "description": "Process title.\nThe proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.title", - "required": false, - "type": "keyword" - }, - "process.parent.uptime": { - "description": "Seconds the process has been up.", - "example": "1325", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.uptime", - "required": false, - "type": "long" - }, - "process.parent.working_directory": { - "description": "The working directory of the process.", - "example": "/home/alice", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.parent.working_directory", - "required": false, - "type": "keyword" - }, - "process.pgid": { - "description": "Identifier of the group of processes the process belongs to.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.pgid", - "required": false, - "type": "long" - }, - "process.pid": { - "description": "Process id.", - "example": "4242", - "footnote": "", - "group": 2, - "level": "core", - "name": "process.pid", - "required": false, - "type": "long" - }, - "process.ppid": { - "description": "Parent process' pid.", - "example": "4241", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.ppid", - "required": false, - "type": "long" - }, - "process.start": { - "description": "The time the process started.", - "example": "2016-05-23T08:05:34.853Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.start", - "required": false, - "type": "date" - }, - "process.thread.id": { - "description": "Thread ID.", - "example": "4242", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.thread.id", - "required": false, - "type": "long" - }, - "process.thread.name": { - "description": "Thread name.", - "example": "thread-0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.thread.name", - "required": false, - "type": "keyword" - }, - "process.title": { - "description": "Process title.\nThe proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.title", - "required": false, - "type": "keyword" - }, - "process.uptime": { - "description": "Seconds the process has been up.", - "example": "1325", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.uptime", - "required": false, - "type": "long" - }, - "process.working_directory": { - "description": "The working directory of the process.", - "example": "/home/alice", - "footnote": "", - "group": 2, - "level": "extended", - "name": "process.working_directory", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "process", - "title": "Process", - "type": "group" - }, - "related": { - "description": "This field set is meant to facilitate pivoting around a piece of data.\nSome pieces of information can be seen in many places in an ECS event. To facilitate searching for them, store an array of all seen values to their corresponding field in `related.`.\nA concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to `related.ip`, you can then search for a given IP trivially, no matter where it appeared, by querying `related.ip:a.b.c.d`.\n", - "fields": { - "related.ip": { - "description": "All of the IPs seen on your event.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "related.ip", - "required": false, - "type": "ip" - } - }, - "group": 2, - "name": "related", - "title": "Related", - "type": "group" - }, - "server": { - "description": "A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records.\nFor TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term \"responder\" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.\nClient / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.\n", - "fields": { - "server.address": { - "description": "Some event server addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.\nThen it should be duplicated to `.ip` or `.domain`, depending on which one it is.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "server.address", - "required": false, - "type": "keyword" - }, - "server.bytes": { - "description": "Bytes sent from the server to the client.", - "example": "184", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.bytes", - "required": false, - "type": "long" - }, - "server.domain": { - "description": "Server domain.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.domain", - "required": false, - "type": "keyword" - }, - "server.ip": { - "description": "IP address of the server.\nCan be one or multiple IPv4 or IPv6 addresses.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.ip", - "required": false, - "type": "ip" - }, - "server.mac": { - "description": "MAC address of the server.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.mac", - "required": false, - "type": "keyword" - }, - "server.nat.ip": { - "description": "Translated ip of destination based NAT sessions (e.g. internet to private DMZ)\nTypically used with load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "server.nat.ip", - "required": false, - "type": "ip" - }, - "server.nat.port": { - "description": "Translated port of destination based NAT sessions (e.g. internet to private DMZ)\nTypically used with load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "server.nat.port", - "required": false, - "type": "long" - }, - "server.packets": { - "description": "Packets sent from the server to the client.", - "example": "12", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.packets", - "required": false, - "type": "long" - }, - "server.port": { - "description": "Port of the server.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "server.port", - "required": false, - "type": "long" - }, - "server.registered_domain": { - "description": "The highest registered server domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "server.registered_domain", - "required": false, - "type": "keyword" - }, - "server.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "server.top_level_domain", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "server", - "title": "Server", - "type": "group" - }, - "service": { - "description": "The service fields describe the service for or from which the data was collected.\nThese fields help you find and correlate logs for a specific service and version.\n", - "fields": { - "service.ephemeral_id": { - "description": "Ephemeral identifier of this service (if one exists).\nThis id normally changes across restarts, but `service.id` does not.", - "example": "8a4f500f", - "footnote": "", - "group": 2, - "level": "extended", - "name": "service.ephemeral_id", - "required": false, - "type": "keyword" - }, - "service.id": { - "description": "Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes.\nThis id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event.\nNote that if you need to see the events from one specific host of the service, you should filter on that `host.name` or `host.id` instead.", - "example": "d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6", - "footnote": "", - "group": 2, - "level": "core", - "name": "service.id", - "required": false, - "type": "keyword" - }, - "service.name": { - "description": "Name of the service data is collected from.\nThe name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name.\nIn the case of Elasticsearch the `service.name` could contain the cluster name. For Beats the `service.name` is by default a copy of the `service.type` field if no name is specified.", - "example": "elasticsearch-metrics", - "footnote": "", - "group": 2, - "level": "core", - "name": "service.name", - "required": false, - "type": "keyword" - }, - "service.node.name": { - "description": "Name of a service node.\nThis allows for two nodes of the same service running on the same host to be differentiated. Therefore, `service.node.name` should typically be unique across nodes of a given service.\nIn the case of Elasticsearch, the `service.node.name` could contain the unique node name within the Elasticsearch cluster. In cases where the service doesn't have the concept of a node name, the host name or container name can be used to distinguish running instances that make up this service. If those do not provide uniqueness (e.g. multiple instances of the service running on the same host) - the node name can be manually set.", - "example": "instance-0000000016", - "footnote": "", - "group": 2, - "level": "extended", - "name": "service.node.name", - "required": false, - "type": "keyword" - }, - "service.state": { - "description": "Current state of the service.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "service.state", - "required": false, - "type": "keyword" - }, - "service.type": { - "description": "The type of the service data is collected from.\nThe type can be used to group and correlate logs and metrics from one service type.\nExample: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`.", - "example": "elasticsearch", - "footnote": "", - "group": 2, - "level": "core", - "name": "service.type", - "required": false, - "type": "keyword" - }, - "service.version": { - "description": "Version of the service the data was collected from.\nThis allows to look at a data set only for a specific version of a service.", - "example": "3.2.4", - "footnote": "", - "group": 2, - "level": "core", - "name": "service.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "service", - "title": "Service", - "type": "group" - }, - "source": { - "description": "Source fields describe details about the source of a packet/event.\nSource fields are usually populated in conjunction with destination fields.\n", - "fields": { - "source.address": { - "description": "Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.\nThen it should be duplicated to `.ip` or `.domain`, depending on which one it is.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "source.address", - "required": false, - "type": "keyword" - }, - "source.bytes": { - "description": "Bytes sent from the source to the destination.", - "example": "184", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.bytes", - "required": false, - "type": "long" - }, - "source.domain": { - "description": "Source domain.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.domain", - "required": false, - "type": "keyword" - }, - "source.ip": { - "description": "IP address of the source.\nCan be one or multiple IPv4 or IPv6 addresses.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.ip", - "required": false, - "type": "ip" - }, - "source.mac": { - "description": "MAC address of the source.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.mac", - "required": false, - "type": "keyword" - }, - "source.nat.ip": { - "description": "Translated ip of source based NAT sessions (e.g. internal client to internet)\nTypically connections traversing load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "source.nat.ip", - "required": false, - "type": "ip" - }, - "source.nat.port": { - "description": "Translated port of source based NAT sessions. (e.g. internal client to internet)\nTypically used with load balancers, firewalls, or routers.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "source.nat.port", - "required": false, - "type": "long" - }, - "source.packets": { - "description": "Packets sent from the source to the destination.", - "example": "12", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.packets", - "required": false, - "type": "long" - }, - "source.port": { - "description": "Port of the source.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "source.port", - "required": false, - "type": "long" - }, - "source.registered_domain": { - "description": "The highest registered source domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "source.registered_domain", - "required": false, - "type": "keyword" - }, - "source.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "source.top_level_domain", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "source", - "title": "Source", - "type": "group" - }, - "threat": { - "description": "Fields to classify events and alerts according to a threat taxonomy such as the Mitre ATT&CK framework.\nThese fields are for users to classify alerts from all of their sources (e.g. IDS, NGFW, etc.) within a common taxonomy. The threat.tactic.* are meant to capture the high level category of the threat (e.g. \"impact\"). The threat.technique.* fields are meant to capture which kind of approach is used by this detected threat, to accomplish the goal (e.g. \"endpoint denial of service\").\n", - "fields": { - "threat.framework": { - "description": "Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events.", - "example": "MITRE ATT&CK", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.framework", - "required": false, - "type": "keyword" - }, - "threat.tactic.id": { - "description": "The id of tactic used by this threat. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/tactics/TA0040/ )", - "example": "TA0040", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.tactic.id", - "required": false, - "type": "keyword" - }, - "threat.tactic.name": { - "description": "Name of the type of tactic used by this threat. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/tactics/TA0040/ )", - "example": "impact", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.tactic.name", - "required": false, - "type": "keyword" - }, - "threat.tactic.reference": { - "description": "The reference url of tactic used by this threat. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/tactics/TA0040/ )", - "example": "https://attack.mitre.org/tactics/TA0040/", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.tactic.reference", - "required": false, - "type": "keyword" - }, - "threat.technique.id": { - "description": "The id of technique used by this tactic. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/techniques/T1499/ )", - "example": "T1499", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.technique.id", - "required": false, - "type": "keyword" - }, - "threat.technique.name": { - "description": "The name of technique used by this tactic. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/techniques/T1499/ )", - "example": "endpoint denial of service", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.technique.name", - "required": false, - "type": "keyword" - }, - "threat.technique.reference": { - "description": "The reference url of technique used by this tactic. You can use the Mitre ATT&CK Matrix Tactic categorization, for example. (ex. https://attack.mitre.org/techniques/T1499/ )", - "example": "https://attack.mitre.org/techniques/T1499/", - "footnote": "", - "group": 2, - "level": "extended", - "name": "threat.technique.reference", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "threat", - "title": "Threat", - "type": "group" - }, - "tls": { - "description": "Fields related to a TLS connection. These fields focus on the TLS protocol itself and intentionally avoids in-depth analysis of the related x.509 certificate files.\n", - "fields": { - "tls.cipher": { - "description": "String indicating the cipher used during the current connection.", - "example": "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.cipher", - "required": false, - "type": "keyword" - }, - "tls.client.certificate": { - "description": "PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list.", - "example": "MII...", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.certificate", - "required": false, - "type": "keyword" - }, - "tls.client.certificate_chain": { - "description": "Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain.", - "example": "['MII...', 'MII...']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.certificate_chain", - "required": false, - "type": "keyword" - }, - "tls.client.hash.md5": { - "description": "Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.hash.md5", - "required": false, - "type": "keyword" - }, - "tls.client.hash.sha1": { - "description": "Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "9E393D93138888D288266C2D915214D1D1CCEB2A", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.hash.sha1", - "required": false, - "type": "keyword" - }, - "tls.client.hash.sha256": { - "description": "Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.hash.sha256", - "required": false, - "type": "keyword" - }, - "tls.client.issuer": { - "description": "Distinguished name of subject of the issuer of the x.509 certificate presented by the client.", - "example": "CN=MyDomain Root CA, OU=Infrastructure Team, DC=mydomain, DC=com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.issuer", - "required": false, - "type": "keyword" - }, - "tls.client.ja3": { - "description": "A hash that identifies clients based on how they perform an SSL/TLS handshake.", - "example": "d4e5b18d6b55c71272893221c96ba240", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.ja3", - "required": false, - "type": "keyword" - }, - "tls.client.not_after": { - "description": "Date/Time indicating when client certificate is no longer considered valid.", - "example": "2021-01-01T00:00:00.000Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.not_after", - "required": false, - "type": "date" - }, - "tls.client.not_before": { - "description": "Date/Time indicating when client certificate is first considered valid.", - "example": "1970-01-01T00:00:00.000Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.not_before", - "required": false, - "type": "date" - }, - "tls.client.server_name": { - "description": "Also called an SNI, this tells the server which hostname to which the client is attempting to connect. When this value is available, it should get copied to `destination.domain`.", - "example": "www.elastic.co", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.server_name", - "required": false, - "type": "keyword" - }, - "tls.client.subject": { - "description": "Distinguished name of subject of the x.509 certificate presented by the client.", - "example": "CN=myclient, OU=Documentation Team, DC=mydomain, DC=com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.subject", - "required": false, - "type": "keyword" - }, - "tls.client.supported_ciphers": { - "description": "Array of ciphers offered by the client during the client hello.", - "example": "['TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384', '...']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.client.supported_ciphers", - "required": false, - "type": "keyword" - }, - "tls.curve": { - "description": "String indicating the curve used for the given cipher, when applicable.", - "example": "secp256r1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.curve", - "required": false, - "type": "keyword" - }, - "tls.established": { - "description": "Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.established", - "required": false, - "type": "boolean" - }, - "tls.next_protocol": { - "description": "String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case.", - "example": "http/1.1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.next_protocol", - "required": false, - "type": "keyword" - }, - "tls.resumed": { - "description": "Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.resumed", - "required": false, - "type": "boolean" - }, - "tls.server.certificate": { - "description": "PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list.", - "example": "MII...", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.certificate", - "required": false, - "type": "keyword" - }, - "tls.server.certificate_chain": { - "description": "Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain.", - "example": "['MII...', 'MII...']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.certificate_chain", - "required": false, - "type": "keyword" - }, - "tls.server.hash.md5": { - "description": "Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.hash.md5", - "required": false, - "type": "keyword" - }, - "tls.server.hash.sha1": { - "description": "Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "9E393D93138888D288266C2D915214D1D1CCEB2A", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.hash.sha1", - "required": false, - "type": "keyword" - }, - "tls.server.hash.sha256": { - "description": "Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.", - "example": "0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.hash.sha256", - "required": false, - "type": "keyword" - }, - "tls.server.issuer": { - "description": "Subject of the issuer of the x.509 certificate presented by the server.", - "example": "CN=MyDomain Root CA, OU=Infrastructure Team, DC=mydomain, DC=com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.issuer", - "required": false, - "type": "keyword" - }, - "tls.server.ja3s": { - "description": "A hash that identifies servers based on how they perform an SSL/TLS handshake.", - "example": "394441ab65754e2207b1e1b457b3641d", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.ja3s", - "required": false, - "type": "keyword" - }, - "tls.server.not_after": { - "description": "Timestamp indicating when server certificate is no longer considered valid.", - "example": "2021-01-01T00:00:00.000Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.not_after", - "required": false, - "type": "date" - }, - "tls.server.not_before": { - "description": "Timestamp indicating when server certificate is first considered valid.", - "example": "1970-01-01T00:00:00.000Z", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.not_before", - "required": false, - "type": "date" - }, - "tls.server.subject": { - "description": "Subject of the x.509 certificate presented by the server.", - "example": "CN=www.mydomain.com, OU=Infrastructure Team, DC=mydomain, DC=com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.subject", - "required": false, - "type": "keyword" - }, - "tls.server.supported_ciphers": { - "description": "Array of ciphers offered by the server during the server hello.", - "example": "['TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384', '...']", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.server.supported_ciphers", - "required": false, - "type": "keyword" - }, - "tls.version": { - "description": "Numeric part of the version parsed from the original string.", - "example": "1.2", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.version", - "required": false, - "type": "keyword" - }, - "tls.version_protocol": { - "description": "Normalized lowercase protocol name parsed from original string.", - "example": "tls", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tls.version_protocol", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "tls", - "title": "TLS", - "type": "group" - }, - "tracing": { - "description": "Distributed tracing makes it possible to analyze performance throughout a microservice architecture all in one view. This is accomplished by tracing all of the requests - from the initial web request in the front-end service - to queries made through multiple back-end services.\n", - "fields": { - "tracing.trace.id": { - "description": "Unique identifier of the trace.\nA trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services.", - "example": "4bf92f3577b34da6a3ce929d0e0e4736", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tracing.trace.id", - "required": false, - "type": "keyword" - }, - "tracing.transaction.id": { - "description": "Unique identifier of the transaction.\nA transaction is the highest level of work measured within a service, such as a request to a server.", - "example": "00f067aa0ba902b7", - "footnote": "", - "group": 2, - "level": "extended", - "name": "tracing.transaction.id", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "tracing", - "title": "Tracing", - "type": "group" - }, - "url": { - "description": "URL fields provide support for complete or partial URLs, and supports the breaking down into scheme, domain, path, and so on.\n", - "fields": { - "url.domain": { - "description": "Domain of the url, such as \"www.elastic.co\".\nIn some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the `domain` field.", - "example": "www.elastic.co", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.domain", - "required": false, - "type": "keyword" - }, - "url.extension": { - "description": "The field contains the file extension from the original request url.\nThe file extension is only set if it exists, as not every url has a file extension.\nThe leading period must not be included. For example, the value must be \"png\", not \".png\".", - "example": "png", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.extension", - "required": false, - "type": "keyword" - }, - "url.fragment": { - "description": "Portion of the url after the `#`, such as \"top\".\nThe `#` is not part of the fragment.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.fragment", - "required": false, - "type": "keyword" - }, - "url.full": { - "description": "If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source.", - "example": "https://www.elastic.co:443/search?q=elasticsearch#top", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.full", - "required": false, - "type": "keyword" - }, - "url.original": { - "description": "Unmodified original url as seen in the event source.\nNote that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path.\nThis field is meant to represent the URL as it was observed, complete or not.", - "example": "https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.original", - "required": false, - "type": "keyword" - }, - "url.password": { - "description": "Password of the request.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.password", - "required": false, - "type": "keyword" - }, - "url.path": { - "description": "Path of the request, such as \"/search\".", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.path", - "required": false, - "type": "keyword" - }, - "url.port": { - "description": "Port of the request, such as 443.", - "example": "443", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.port", - "required": false, - "type": "long" - }, - "url.query": { - "description": "The query field describes the query string of the request, such as \"q=elasticsearch\".\nThe `?` is excluded from the query string. If a URL contains no `?`, there is no query field. If there is a `?` but no query, the query field exists with an empty string. The `exists` query can be used to differentiate between the two cases.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.query", - "required": false, - "type": "keyword" - }, - "url.registered_domain": { - "description": "The highest registered url domain, stripped of the subdomain.\nFor example, the registered domain for \"foo.google.com\" is \"google.com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as \"co.uk\".", - "example": "google.com", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.registered_domain", - "required": false, - "type": "keyword" - }, - "url.scheme": { - "description": "Scheme of the request, such as \"https\".\nNote: The `:` is not part of the scheme.", - "example": "https", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.scheme", - "required": false, - "type": "keyword" - }, - "url.top_level_domain": { - "description": "The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is \"com\".\nThis value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as \"co.uk\".", - "example": "co.uk", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.top_level_domain", - "required": false, - "type": "keyword" - }, - "url.username": { - "description": "Username of the request.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "url.username", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "url", - "title": "URL", - "type": "group" - }, - "user": { - "description": "The user fields describe information about the user that is relevant to the event.\nFields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.\n", - "fields": { - "user.domain": { - "description": "Name of the directory the user is a member of.\nFor example, an LDAP or Active Directory domain name.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user.domain", - "required": false, - "type": "keyword" - }, - "user.email": { - "description": "User email address.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user.email", - "required": false, - "type": "keyword" - }, - "user.full_name": { - "description": "User's full name, if available.", - "example": "Albert Einstein", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user.full_name", - "required": false, - "type": "keyword" - }, - "user.hash": { - "description": "Unique user hash to correlate information for a user in anonymized form.\nUseful if `user.id` or `user.name` contain confidential information and cannot be used.", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user.hash", - "required": false, - "type": "keyword" - }, - "user.id": { - "description": "One or multiple unique identifiers of the user.", - "example": "", - "footnote": "", - "group": 2, - "level": "core", - "name": "user.id", - "required": false, - "type": "keyword" - }, - "user.name": { - "description": "Short name or login of the user.", - "example": "albert", - "footnote": "", - "group": 2, - "level": "core", - "name": "user.name", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "user", - "title": "User", - "type": "group" - }, - "user_agent": { - "description": "The user_agent fields normally come from a browser request.\nThey often show up in web service logs coming from the parsed user agent string.\n", - "fields": { - "user_agent.device.name": { - "description": "Name of the device.", - "example": "iPhone", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user_agent.device.name", - "required": false, - "type": "keyword" - }, - "user_agent.name": { - "description": "Name of the user agent.", - "example": "Safari", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user_agent.name", - "required": false, - "type": "keyword" - }, - "user_agent.original": { - "description": "Unparsed version of the user_agent.", - "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user_agent.original", - "required": false, - "type": "keyword" - }, - "user_agent.version": { - "description": "Version of the user agent.", - "example": "12.0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "user_agent.version", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "user_agent", - "title": "User agent", - "type": "group" - }, - "vulnerability": { - "description": "The vulnerability fields describe information about a vulnerability that is relevant to an event.\n", - "fields": { - "vulnerability.category": { - "description": "The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm)\nThis field must be an array.", - "example": "[\"Firewall\"]", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.category", - "required": false, - "type": "keyword" - }, - "vulnerability.classification": { - "description": "The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/)", - "example": "CVSS", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.classification", - "required": false, - "type": "keyword" - }, - "vulnerability.description": { - "description": "The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created)", - "example": "In macOS before 2.12.6, there is a vulnerability in the RPC...", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.description", - "required": false, - "type": "keyword" - }, - "vulnerability.enumeration": { - "description": "The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/)", - "example": "CVE", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.enumeration", - "required": false, - "type": "keyword" - }, - "vulnerability.id": { - "description": "The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)", - "example": "CVE-2019-00001", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.id", - "required": false, - "type": "keyword" - }, - "vulnerability.reference": { - "description": "A resource that provides additional information, context, and mitigations for the identified vulnerability.", - "example": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.reference", - "required": false, - "type": "keyword" - }, - "vulnerability.report_id": { - "description": "The report or scan identification number.", - "example": "20191018.0001", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.report_id", - "required": false, - "type": "keyword" - }, - "vulnerability.scanner.vendor": { - "description": "The name of the vulnerability scanner vendor.", - "example": "Tenable", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.scanner.vendor", - "required": false, - "type": "keyword" - }, - "vulnerability.score.base": { - "description": "Scores can range from 0.0 to 10.0, with 10.0 being the most severe.\nBase scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentialy, integrity, and availability), and scope. For example (https://www.first.org/cvss/specification-document)", - "example": "5.5", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.score.base", - "required": false, - "type": "float" - }, - "vulnerability.score.environmental": { - "description": "Scores can range from 0.0 to 10.0, with 10.0 being the most severe.\nEnvironmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (https://www.first.org/cvss/specification-document)", - "example": "5.5", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.score.environmental", - "required": false, - "type": "float" - }, - "vulnerability.score.temporal": { - "description": "Scores can range from 0.0 to 10.0, with 10.0 being the most severe.\nTemporal scores cover an assessment for code maturity, remediation level, and confidence. For example (https://www.first.org/cvss/specification-document)", - "example": "", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.score.temporal", - "required": false, - "type": "float" - }, - "vulnerability.score.version": { - "description": "The National Vulnerability Database (NVD) provides qualitative severity rankings of \"Low\", \"Medium\", and \"High\" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification.\nCVSS is owned and managed by FIRST.Org, Inc. (FIRST), a US-based non-profit organization, whose mission is to help computer security incident response teams across the world. For example (https://nvd.nist.gov/vuln-metrics/cvss)", - "example": "2.0", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.score.version", - "required": false, - "type": "keyword" - }, - "vulnerability.severity": { - "description": "The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss)", - "example": "Critical", - "footnote": "", - "group": 2, - "level": "extended", - "name": "vulnerability.severity", - "required": false, - "type": "keyword" - } - }, - "group": 2, - "name": "vulnerability", - "title": "Vulnerability", - "type": "group" - } -} \ No newline at end of file diff --git a/scripts/schemas.py b/scripts/schemas.py deleted file mode 100644 index 798ec84cd3..0000000000 --- a/scripts/schemas.py +++ /dev/null @@ -1,117 +0,0 @@ -import os -import yaml -import sys -import copy -from helper import * -import argparse -from functools import reduce -import json - - -def addNamespace(namespaces, namespace): - namespaces[namespace["name"]] = { - "name": namespace["name"], - "title": namespace["title"], - "description": namespace["description"], - "type": namespace["type"], - "group": namespace["group"], - "fields": {} - } - - return namespaces - - -def addFields(namespaces, namespace): - namespaceName = namespace["name"] - - def fieldAsJson(fieldsByName, field): - fieldsByName[field["name"]] = { - "name": field["name"], - "type": field["type"], - "required": field.get("required", False), - "description": field["description"], - "example": field["example"], - "group": field["group"], - "level": field["level"], - "footnote": field["footnote"], - } - - return fieldsByName - - namespaces[namespaceName]["fields"] = reduce(fieldAsJson, namespace["fields"], {}) - return namespaces - - -def create_json(fields, file): - open_mode = "wb" - if sys.version_info >= (3, 0): - open_mode = "w" - - # Output schema to json - with open(file, open_mode) as jsonfile: - root = reduce(addNamespace, fields, {}) - schema = reduce(addFields, fields, root) - - jsonfile.write(json.dumps(schema, indent=2, sort_keys=True)) - - -def create_markdown_document(fields): - # Create markdown schema output string - tables = "" - - links = "" - for namespace in fields: - if len(namespace["fields"]) == 0: - continue - # Links to each namespace / top level object - links += " * [{} fields](#{})\n".format(namespace["title"], namespace["name"]) - tables += get_markdown_section(namespace) - - return links + "\n" + tables + "\n\n" - - -def filtered_fields(fields, groups): - new_fields = copy.deepcopy(fields) - for f in new_fields: - n = 0 - for field in list(f["fields"]): - if field["group"] not in groups: - del f["fields"][n] - continue - n = n + 1 - - return new_fields - - -def check_fields(fields): - for f in fields: - for field in list(f["fields"]): - if field["level"] not in ["core", "extended"]: - raise Exception('Field {} does not have an allowed level'.format(field["name"])) - - -if __name__ == "__main__": - - fields = get_schema() - - # Load all fields into object - sortedNamespaces = sorted(fields, key=lambda field: field["group"]) - - parser = argparse.ArgumentParser() - parser.add_argument('--stdout', help='output to stdout instead of files') - args = parser.parse_args() - - check_fields(sortedNamespaces) - - # Generates Markdown for README - if args.stdout == "true": - groups = [1, 2, 3] - f_fields = filtered_fields(sortedNamespaces, groups) - # Print to stdout - print(create_markdown_document(f_fields)) - - # Generates schema.csv - else: - groups = [1, 2, 3] - f_fields = filtered_fields(sortedNamespaces, groups) - create_json(f_fields, "schema.json")