Juniper SRX Integration for Elastic
| Version | 1.27.0 (View all) |
| Subscription level What's this? |
Basic |
| Developed by What's this? |
Elastic |
| Ingestion method(s) | File, Network Protocol |
| Minimum Kibana version(s) | 9.0.0 8.11.0 |
This AI-assisted guide was validated by our engineers. You may need to adjust the steps to match your environment.
The Juniper SRX integration for Elastic enables you to collect and analyze logs from Juniper SRX Series Firewalls. By ingesting these logs into the Elastic Stack, you gain comprehensive visibility into your network's security posture and operational status. You can use this data to identify threats, monitor traffic patterns, and troubleshoot network issues effectively.
This integration is compatible with Juniper SRX Series Firewalls running Junos versions that support structured-data logging. Your device must be capable of generating syslog messages in the structured-data + brief format for successful parsing.
This integration collects logs from Juniper SRX firewalls by receiving syslog data over TCP or UDP, or reading a log file. You deploy an Elastic Agent on a host that is configured as a syslog receiver. The agent listens for incoming logs, parses the structured messages, and forwards the data to your Elastic deployment into the log data stream. The agent can also watch log files written locally to the Elastic Agent's host. This allows you to visualize and search your security data in real-time.
The Juniper SRX integration collects log messages in structured-data format from various security and system processes. It processes the following types of data:
- Firewall session logs: Information on session creation, closing, and denials (
RT_FLOW). - Intrusion detection and prevention (IDP) logs: Security screen events and attack log events (
RT_IDS,RT_IDP). - Unified threat management (UTM) logs: Events related to web filtering, antivirus, and antispam detection (
RT_UTM). - Advanced anti-malware logs: Records of malware actions and host infection events (
RT_AAMW). - Security intelligence logs: Data related to security intelligence actions (
RT_SECINTEL). - Juniper SRX logs: Captures all the security and system processes mentioned above in structured-data format.
The following processes and tags are supported:
| JunOS processes | JunOS tags |
|---|---|
| RT_FLOW | RT_FLOW_SESSION_CREATE |
| RT_FLOW_SESSION_CLOSE | |
| RT_FLOW_SESSION_DENY | |
| APPTRACK_SESSION_CREATE | |
| APPTRACK_SESSION_CLOSE | |
| APPTRACK_SESSION_VOL_UPDATE | |
| RT_IDS | RT_SCREEN_TCP |
| RT_SCREEN_UDP | |
| RT_SCREEN_ICMP | |
| RT_SCREEN_IP | |
| RT_SCREEN_TCP_DST_IP | |
| RT_SCREEN_TCP_SRC_IP | |
| RT_UTM | WEBFILTER_URL_PERMITTED |
| WEBFILTER_URL_BLOCKED | |
| AV_VIRUS_DETECTED_MT | |
| CONTENT_FILTERING_BLOCKED_MT | |
| ANTISPAM_SPAM_DETECTED_MT | |
| RT_IDP | IDP_ATTACK_LOG_EVENT |
| IDP_APPDDOS_APP_STATE_EVENT | |
| RT_AAMW | SRX_AAMW_ACTION_LOG |
| AAMW_MALWARE_EVENT_LOG | |
| AAMW_HOST_INFECTED_EVENT_LOG | |
| AAMW_ACTION_LOG | |
| RT_SECINTEL | SECINTEL_ACTION_LOG |
Integrating your Juniper SRX logs with the Elastic Stack provides several security and operational benefits. You can use this integration for the following:
- Real-time threat monitoring: Identify and respond to threats detected by IDP, UTM, and anti-malware systems as they happen.
- Network visibility: Analyze firewall session data to understand traffic patterns and identify potential bottlenecks or unusual activity.
- Security auditing: Maintain a searchable, long-term archive of security events and intelligence actions to support compliance requirements.
- Incident investigation: Use detailed session and security logs to trace the origin and impact of security incidents across your network.
To collect logs from your Juniper SRX devices, you'll need to meet these vendor-specific requirements:
- Gain administrative access to the Juniper SRX CLI using SSH or a console connection to perform configuration changes.
- Ensure network connectivity exists between the Juniper SRX management or data interfaces and the host running the Elastic Agent.
- Set up firewall rules to allow traffic on the configured syslog port, which defaults to
9006for this integration. - Use an SRX device running a Junos version that supports
structured-datasyslog formatting.
You'll also need to prepare your Elastic environment with the following:
- Install and enroll an Elastic Agent in Fleet or configure it to run in standalone mode.
- Install the Juniper SRX integration package in Kibana.
- Ensure network access is available for the agent to receive inbound syslog traffic on your specified port.
You must install Elastic Agent on a host that can receive syslog data or access log files from your Juniper SRX device. For more details, check the Elastic Agent installation instructions. You'll only need one Elastic Agent per host.
You'll need the Elastic Agent to stream data from the syslog or log file receiver and ship it to Elastic. From there, the integration's ingest pipelines will process the events.
You can configure your Juniper SRX device to send logs using syslog or write them to a file for collection.
Follow these steps to configure remote syslog:
- Log in to the Juniper SRX device using SSH or the console port.
- Enter configuration mode by typing
configure. - Set the remote syslog destination to the IP address of your Elastic Agent. Replace
<AGENT_IP>with your agent's IP and<PORT>with your configured port (for example,9006).set system syslog host <AGENT_IP> any any set system syslog host <AGENT_IP> port 9006 - Configure the mandatory log format. This integration only supports the
structured-dataformat with thebriefoption:set system syslog host <AGENT_IP> structured-data brief - Set the security logging mode to
eventto ensure security logs are sent to the syslog process:set security log mode event set security log format syslog - Verify your configuration by running
show system syslog. Ensure the host entry includes thestructured-data { brief; }block. - Commit your changes by typing
commit.
Follow these steps to write logs to a local file:
- Log in to the Juniper SRX device or the intermediate log host.
- Configure the SRX to write logs to a file using the structured format:
set system syslog file juniper-srx.log any any set system syslog file juniper-srx.log structured-data brief - Ensure the Elastic Agent has read permissions for the file. The default path is
/var/log/juniper-srx.log. - Commit the changes on the SRX device.
For more information, refer to these Juniper resources:
- Junos CLI reference | structured-data
- Direct system log messages to a remote destination
- SRX Getting Started - Configure System Logging
- SRX Getting Started - Configure Traffic Logging (Security Policy Logs) for SRX Branch Devices
You'll need to enable and configure the integration input method that matches your Juniper configuration. Follow the setup instructions that match your configuration.
This input collects logs over a UDP socket.
- In Kibana, navigate to Management > Integrations and search for Juniper SRX.
- Click Add Juniper SRX.
- Locate the Collecting syslog from Juniper SRX via UDP input.
- Configure the
syslog_host(default:localhost) andsyslog_port(default:9006). - If you want to keep the raw log, enable Preserve original event to store it in
event.original. - Optionally, configure Custom UDP Options like
read_buffer(default100MiB) ormax_message_size(default50KiB). - Save the integration to your Agent policy.
This input collects logs over a TCP socket.
- In Kibana, navigate to Management > Integrations and search for Juniper SRX.
- Click Add Juniper SRX.
- Locate the Collecting syslog from Juniper SRX via TCP input.
- Configure the
syslog_host(default:localhost) andsyslog_port(default:9006). - If you're using encryption, configure the SSL Configuration settings with your certificate and key.
- Under Custom TCP Options, you can set the
framingmethod (defaultdelimiter) ormax_connections. - Save the integration to your Agent policy.
This input collects logs directly from files on the host where the Elastic Agent is running.
- In Kibana, navigate to Management > Integrations and search for Juniper SRX.
- Click Add Juniper SRX.
- Locate the Collecting syslog from Juniper SRX via file input.
- Set the
pathsto the absolute path of your log files (default:/var/log/juniper-srx.log). - Save the integration to your Agent policy.
After you've finished the configuration, verify that data is flowing correctly into Elasticsearch.
To trigger data flow, perform these actions on your Juniper SRX:
- Generate traffic events: From a device behind the firewall, visit a website or ping an external IP that matches a logged security policy.
- Generate configuration events: Enter configuration mode in the CLI, make a minor change like an interface description, and run
commit. - Generate authentication events: Log out and back into the SRX CLI or J-Web interface.
To check the data in Kibana:
- Navigate to Analytics > Discover.
- Select the
logs-*data view. - Filter for
data_stream.dataset: "juniper_srx.log". - Verify that logs appear and contain expected fields like
event.action,source.ip, orevent.outcome. - Navigate to Analytics > Dashboards and search for "Juniper SRX" to see the pre-built visualizations.
For help with Elastic ingest tools, check Common problems.
You might encounter the following issues when configuring the Juniper SRX integration:
- Missing structured data format: If logs appear in Kibana as a raw string in the
messagefield and are not parsed, ensure you've committed theset system syslog host <IP> structured-data briefcommand on the SRX device. This integration requires thestructured-dataformat to identify fields. - Security logs not sent: If you receive system logs but traffic or IDP logs (like
RT_FLOWorRT_IDS) are missing, verify thatset security log mode eventis configured in the Junos CLI. By default, SRX devices might send security logs using the data plane, bypassing system syslog settings. - Port mismatch: Confirm that the port configured on the Juniper SRX (for example,
set system syslog host <IP> port 9006) matches thesyslog_portvalue in your Elastic Agent integration settings. - Network connectivity issues: Verify there are no firewalls or network Access Control Lists (ACLs) blocking UDP or TCP traffic on port
9006between the SRX management interface and the Elastic Agent host. - Parsing failures: Check the
error.messagefield in Kibana. If it contains "Provided Grok expressions do not match", it typically indicates the device is sending logs in standard syslog format instead of the requiredstructured-dataformat. - Incomplete or truncated logs: If log messages are cut off, you might need to increase the
max_message_sizein the integration's UDP or TCP options to accommodate large structured-data payloads.
To ensure optimal performance in high-volume environments, consider the following:
- Manage your data volume by configuring the Juniper SRX appliance to forward only necessary events, such as
RT_FLOWorRT_IDS, using Junos syslog facility and severity filters. Don't forward excessive debug-level logs at the source because it can overwhelm the ingest pipeline. - Scale your deployment by placing multiple Elastic Agents behind a network load balancer to distribute the ingestion load in high-throughput environments. You should place agents in close network proximity to the SRX devices to reduce latency and minimize the impact of network congestion on log delivery.
For more information on architectures that can be used for scaling this integration, check the Ingest Architectures documentation.
These inputs can be used with this integration:
filestream
For more details about the Filestream input settings, check the Filebeat documentation.
To collect logs via Filestream, select Collect logs via Filestream and configure the following parameters:
- Filestream paths: The full path to the related log file.
tcp
For more details about the TCP input settings, check the Filebeat documentation.
To collect logs via TCP, select Collect logs via TCP and configure the following parameters:
Required Settings:
- Host
- Port
Common Optional Settings:
- Max Message Size - Maximum size of incoming messages
- Max Connections - Maximum number of concurrent connections
- Timeout - How long to wait for data before closing idle connections
- Line Delimiter - Character(s) that separate log messages
To enable encrypted connections, configure the following SSL settings:
SSL Settings:
- Enable SSL - Toggle to enable SSL/TLS encryption
- Certificate - Path to the SSL certificate file (
.crtor.pem) - Certificate Key - Path to the private key file (
.key) - Certificate Authorities - Path to CA certificate file for client certificate validation (optional)
- Client Authentication - Require client certificates (
none,optional, orrequired) - Supported Protocols - TLS versions to support (e.g.,
TLSv1.2,TLSv1.3)
Example SSL Configuration:
ssl.enabled: true
ssl.certificate: "/path/to/server.crt"
ssl.key: "/path/to/server.key"
ssl.certificate_authorities: ["/path/to/ca.crt"]
ssl.client_authentication: "optional"
udp
For more details about the UDP input settings, check the Filebeat documentation.
To collect logs via UDP, select Collect logs via UDP and configure the following parameters:
Required Settings:
- Host
- Port
Common Optional Settings:
- Max Message Size - Maximum size of UDP packets to accept (default: 10KB, max: 64KB)
- Read Buffer - UDP socket read buffer size for handling bursts of messages
- Read Timeout - How long to wait for incoming packets before checking for shutdown
The following resources provide additional information about Juniper SRX logging and configuration:
- Juniper SRX Product Page
- Junos Documentation on Structured Data
- Direct System Log Messages to a Remote Destination - Juniper Networks
- Example: Forward structured system syslog messages from SRX - Juniper Support
- KB16502 - Configure System Logging
The log data stream provides events from Juniper SRX devices. These logs include the following types:
- Traffic logs
- Security logs
- Authentication logs
- Junos OS system events
Exported fields
| Field | Description | Type |
|---|---|---|
| @timestamp | Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline. Required field for all events. | date |
| agent.build.original | Extended build information for the agent. This field is intended to contain any build information that a data source may provide, no specific formatting is required. | keyword |
| agent.ephemeral_id | Ephemeral identifier of this agent (if one exists). This id normally changes across restarts, but agent.id does not. |
keyword |
| agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword |
| agent.name | Custom name of the agent. This 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. | keyword |
| agent.type | Type of the agent. The agent type always stays 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. | keyword |
| agent.version | Version of the agent. | keyword |
| client.address | 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. Then it should be duplicated to .ip or .domain, depending on which one it is. |
keyword |
| client.as.organization.name | Organization name. | keyword |
| client.as.organization.name.text | Multi-field of client.as.organization.name. |
match_only_text |
| client.bytes | Bytes sent from the client to the server. | long |
| client.domain | The domain name of the client system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
| client.ip | IP address of the client (IPv4 or IPv6). | ip |
| client.mac | MAC address of the client. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| client.nat.ip | Translated IP of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. | ip |
| client.nat.port | Translated port of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. | long |
| client.packets | Packets sent from the client to the server. | long |
| client.port | Port of the client. | long |
| client.registered_domain | The highest registered client domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| client.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| client.user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| client.user.email | User email address. | keyword |
| client.user.full_name | User's full name, if available. | keyword |
| client.user.full_name.text | Multi-field of client.user.full_name. |
match_only_text |
| client.user.group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| client.user.group.id | Unique identifier for the group on the system/platform. | keyword |
| client.user.group.name | Name of the group. | keyword |
| client.user.hash | Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used. |
keyword |
| client.user.id | Unique identifier of the user. | keyword |
| client.user.name | Short name or login of the user. | keyword |
| client.user.name.text | Multi-field of client.user.name. |
match_only_text |
| client.user.roles | Array of user roles at the time of the event. | keyword |
| cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword |
| cloud.account.name | The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. | keyword |
| cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword |
| cloud.image.id | Image ID for the cloud instance. | keyword |
| cloud.instance.id | Instance ID of the host machine. | keyword |
| cloud.instance.name | Instance name of the host machine. | keyword |
| cloud.machine.type | Machine type of the host machine. | keyword |
| cloud.project.id | The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. | keyword |
| cloud.project.name | The cloud project name. Examples: Google Cloud Project name, Azure Project name. | keyword |
| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
| cloud.region | Region in which this host, resource, or service is located. | keyword |
| container.id | Unique container id. | keyword |
| container.image.name | Name of the image the container was built on. | keyword |
| container.image.tag | Container image tags. | keyword |
| container.labels | Image labels. | object |
| container.name | Container name. | keyword |
| container.runtime | Runtime managing this container. | keyword |
| data_stream.dataset | Data stream dataset. | constant_keyword |
| data_stream.namespace | Data stream namespace. | constant_keyword |
| data_stream.type | Data stream type. | constant_keyword |
| destination.address | 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. Then it should be duplicated to .ip or .domain, depending on which one it is. |
keyword |
| destination.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
| destination.as.organization.name | Organization name. | keyword |
| destination.as.organization.name.text | Multi-field of destination.as.organization.name. |
match_only_text |
| destination.bytes | Bytes sent from the destination to the source. | long |
| destination.domain | The domain name of the destination system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
| destination.geo.city_name | City name. | keyword |
| destination.geo.continent_name | Name of the continent. | keyword |
| destination.geo.country_iso_code | Country ISO code. | keyword |
| destination.geo.country_name | Country name. | keyword |
| destination.geo.location | Longitude and latitude. | geo_point |
| destination.geo.name | User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. | keyword |
| destination.geo.region_iso_code | Region ISO code. | keyword |
| destination.geo.region_name | Region name. | keyword |
| destination.ip | IP address of the destination (IPv4 or IPv6). | ip |
| destination.mac | MAC address of the destination. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| destination.nat.ip | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. | ip |
| destination.nat.port | Port the source session is translated to by NAT Device. Typically used with load balancers, firewalls, or routers. | long |
| destination.packets | Packets sent from the destination to the source. | long |
| destination.port | Port of the destination. | long |
| destination.registered_domain | The highest registered destination domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| destination.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| destination.user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| destination.user.email | User email address. | keyword |
| destination.user.full_name | User's full name, if available. | keyword |
| destination.user.full_name.text | Multi-field of destination.user.full_name. |
match_only_text |
| destination.user.group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| destination.user.group.id | Unique identifier for the group on the system/platform. | keyword |
| destination.user.group.name | Name of the group. | keyword |
| destination.user.hash | Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used. |
keyword |
| destination.user.id | Unique identifier of the user. | keyword |
| destination.user.name | Short name or login of the user. | keyword |
| destination.user.name.text | Multi-field of destination.user.name. |
match_only_text |
| destination.user.roles | Array of user roles at the time of the event. | keyword |
| dll.code_signature.exists | Boolean to capture if a signature is present. | boolean |
| dll.code_signature.status | Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. | keyword |
| dll.code_signature.subject_name | Subject name of the code signer | keyword |
| dll.code_signature.trusted | Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. | boolean |
| dll.code_signature.valid | Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. | boolean |
| dll.hash.md5 | MD5 hash. | keyword |
| dll.hash.sha1 | SHA1 hash. | keyword |
| dll.hash.sha256 | SHA256 hash. | keyword |
| dll.hash.sha512 | SHA512 hash. | keyword |
| dll.name | Name of the library. This generally maps to the name of the file on disk. | keyword |
| dll.path | Full file path of the library. | keyword |
| dll.pe.architecture | CPU architecture target for the file. | keyword |
| dll.pe.company | Internal company name of the file, provided at compile-time. | keyword |
| dll.pe.description | Internal description of the file, provided at compile-time. | keyword |
| dll.pe.file_version | Internal version of the file, provided at compile-time. | keyword |
| dll.pe.imphash | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. | keyword |
| dll.pe.original_file_name | Internal name of the file, provided at compile-time. | keyword |
| dll.pe.product | Internal product name of the file, provided at compile-time. | keyword |
| dns.answers | An array containing an object for each answer section returned by the server. The 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. Not 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. |
group |
| dns.answers.class | The class of DNS data contained in this resource record. | keyword |
| dns.answers.data | The data describing the resource. The meaning of this data depends on the type and class of the resource record. | keyword |
| dns.answers.name | The domain name to which this resource record pertains. If 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. |
keyword |
| dns.answers.ttl | 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. | long |
| dns.answers.type | The type of data contained in this resource record. | keyword |
| dns.header_flags | Array of 2 letter DNS header flags. | keyword |
| dns.id | The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response. | keyword |
| dns.op_code | 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. | keyword |
| dns.question.class | The class of records being queried. | keyword |
| dns.question.name | The name being queried. If 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. | keyword |
| dns.question.registered_domain | The highest registered domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| dns.question.subdomain | The subdomain is all of the labels under the registered_domain. If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. | keyword |
| dns.question.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| dns.question.type | The type of record being queried. | keyword |
| dns.resolved_ip | Array containing all IPs seen in answers.data. The 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. |
ip |
| dns.response_code | The DNS response code. | keyword |
| dns.type | The type of DNS event captured, query or answer. If your source of DNS events only gives you DNS queries, you should only create dns events of type dns.type:query. If 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. |
keyword |
| ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. |
keyword |
| error.code | Error code describing the error. | keyword |
| error.id | Unique identifier for the error. | keyword |
| error.message | Error message. | match_only_text |
| error.stack_trace | The stack trace of this error in plain text. | wildcard |
| error.stack_trace.text | Multi-field of error.stack_trace. |
match_only_text |
| error.type | The type of the error, for example the class name of the exception. | keyword |
| event.action | The action captured by the event. This 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. |
keyword |
| event.category | This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories. |
keyword |
| event.code | Identification code for this event, if one exists. Some 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. | keyword |
| event.created | event.created contains the date/time when the event was first read by an agent, or by your pipeline. This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event. In 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. In case the two timestamps are identical, @timestamp should be used. |
date |
| event.dataset | Event dataset | constant_keyword |
| event.duration | Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time. |
long |
| event.end | event.end contains the date when the event ended or when the activity was last observed. |
date |
| event.hash | Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity. | keyword |
| event.id | Unique ID to describe the event. | keyword |
| event.ingested | Timestamp when an event arrived in the central data store. This 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. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested. |
date |
| event.kind | This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data is coming in at a regular interval or not. |
keyword |
| event.module | Event module | constant_keyword |
| event.original | Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from _source. If users wish to override this and index this field, please see Field data types in the Elasticsearch Reference. |
keyword |
| event.outcome | This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. event.outcome simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. Note that when a single transaction is described in multiple events, each event may populate different values of event.outcome, according to their perspective. Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer. Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with event.type:info, or any events for which an outcome does not make logical sense. |
keyword |
| event.provider | Source of the event. Event 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). | keyword |
| event.reason | Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where event.action captures the action from the event, event.reason describes why that action was taken. For example, a web proxy with an event.action which denied the request may also populate event.reason with the reason why (e.g. blocked site). |
keyword |
| event.reference | Reference URL linking to additional information about this event. This URL links to a static definition of this event. Alert events, indicated by event.kind:alert, are a common use case for this field. |
keyword |
| event.risk_score | Risk score or priority of the event (e.g. security solutions). Use your system's original value here. | float |
| event.risk_score_norm | Normalized risk score or priority of the event, on a scale of 0 to 100. This 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. | float |
| event.sequence | Sequence number of the event. The sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regardless of the timestamp precision. | long |
| event.severity | The numeric severity of the event according to your event source. What 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. The 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. |
long |
| event.start | event.start contains the date when the event started or when the activity was first observed. |
date |
| event.timezone | 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. Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00"). | keyword |
| event.type | This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types. |
keyword |
| event.url | URL linking to an external system to continue investigation of this event. This URL links to another system where in-depth investigation of the specific occurrence of this event can take place. Alert events, indicated by event.kind:alert, are a common use case for this field. |
keyword |
| file.accessed | Last time the file was accessed. Note that not all filesystems keep track of access time. | date |
| file.attributes | Array of file attributes. Attributes names will vary by platform. Here's a non-exhaustive list of values that are expected in this field: archive, compressed, directory, encrypted, execute, hidden, read, readonly, system, write. | keyword |
| file.code_signature.exists | Boolean to capture if a signature is present. | boolean |
| file.code_signature.status | Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. | keyword |
| file.code_signature.subject_name | Subject name of the code signer | keyword |
| file.code_signature.trusted | Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. | boolean |
| file.code_signature.valid | Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. | boolean |
| file.created | File creation time. Note that not all filesystems store the creation time. | date |
| file.ctime | Last time the file attributes or metadata changed. Note 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. |
date |
| file.device | Device that is the source of the file. | keyword |
| file.directory | Directory where the file is located. It should include the drive letter, when appropriate. | keyword |
| file.drive_letter | Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon. | keyword |
| file.extension | File extension, excluding the leading dot. Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). | keyword |
| file.gid | Primary group ID (GID) of the file. | keyword |
| file.group | Primary group name of the file. | keyword |
| file.hash.md5 | MD5 hash. | keyword |
| file.hash.sha1 | SHA1 hash. | keyword |
| file.hash.sha256 | SHA256 hash. | keyword |
| file.hash.sha512 | SHA512 hash. | keyword |
| file.inode | Inode representing the file in the filesystem. | keyword |
| file.mime_type | MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. | keyword |
| file.mode | Mode of the file in octal representation. | keyword |
| file.mtime | Last time the file content was modified. | date |
| file.name | Name of the file including the extension, without the directory. | keyword |
| file.owner | File owner's username. | keyword |
| file.path | Full path to the file, including the file name. It should include the drive letter, when appropriate. | keyword |
| file.path.text | Multi-field of file.path. |
match_only_text |
| file.pe.architecture | CPU architecture target for the file. | keyword |
| file.pe.company | Internal company name of the file, provided at compile-time. | keyword |
| file.pe.description | Internal description of the file, provided at compile-time. | keyword |
| file.pe.file_version | Internal version of the file, provided at compile-time. | keyword |
| file.pe.imphash | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. | keyword |
| file.pe.original_file_name | Internal name of the file, provided at compile-time. | keyword |
| file.pe.product | Internal product name of the file, provided at compile-time. | keyword |
| file.size | File size in bytes. Only relevant when file.type is "file". |
long |
| file.target_path | Target path for symlinks. | keyword |
| file.target_path.text | Multi-field of file.target_path. |
match_only_text |
| file.type | File type (file, dir, or symlink). | keyword |
| file.uid | The user ID (UID) or security identifier (SID) of the file owner. | keyword |
| group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| group.id | Unique identifier for the group on the system/platform. | keyword |
| group.name | Name of the group. | keyword |
| host.architecture | Operating system architecture. | keyword |
| host.containerized | If the host is a container. | boolean |
| host.domain | Name of the domain of which the host is a member. For 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. | keyword |
| host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. |
keyword |
| host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name. |
keyword |
| host.ip | Host ip addresses. | ip |
| host.mac | Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword |
| host.os.build | OS build information. | keyword |
| host.os.codename | OS codename, if any. | keyword |
| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
| host.os.full | Operating system name, including the version or code name. | keyword |
| host.os.full.text | Multi-field of host.os.full. |
match_only_text |
| host.os.kernel | Operating system kernel version as a raw string. | keyword |
| host.os.name | Operating system name, without the version. | keyword |
| host.os.name.text | Multi-field of host.os.name. |
match_only_text |
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
| host.os.version | Operating system version as a raw string. | keyword |
| host.type | Type of host. For 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. |
keyword |
| host.uptime | Seconds the host has been up. | long |
| http.request.body.bytes | Size in bytes of the request body. | long |
| http.request.body.content | The full HTTP request body. | wildcard |
| http.request.body.content.text | Multi-field of http.request.body.content. |
match_only_text |
| http.request.bytes | Total size in bytes of the request (body and headers). | long |
| http.request.method | HTTP request method. The value should retain its casing from the original event. For example, GET, get, and GeT are all considered valid values for this field. |
keyword |
| http.request.referrer | Referrer for this HTTP request. | keyword |
| http.response.body.bytes | Size in bytes of the response body. | long |
| http.response.body.content | The full HTTP response body. | wildcard |
| http.response.body.content.text | Multi-field of http.response.body.content. |
match_only_text |
| http.response.bytes | Total size in bytes of the response (body and headers). | long |
| http.response.status_code | HTTP response status code. | long |
| http.version | HTTP version. | keyword |
| input.type | Input type. | keyword |
| juniper.srx.action | action | keyword |
| juniper.srx.action_detail | action detail | keyword |
| juniper.srx.admin_status | keyword | |
| juniper.srx.alert | repeat alert | keyword |
| juniper.srx.apbr_rule_type | apbr rule type | keyword |
| juniper.srx.application | application | keyword |
| juniper.srx.application_category | application category | keyword |
| juniper.srx.application_characteristics | application characteristics | keyword |
| juniper.srx.application_name | application name | keyword |
| juniper.srx.application_sub_category | application sub category | keyword |
| juniper.srx.argument1 | keyword | |
| juniper.srx.attack_name | attack name | keyword |
| juniper.srx.category | filter category | keyword |
| juniper.srx.client_ip | client ip | ip |
| juniper.srx.connection_hit_rate | connection hit rate | integer |
| juniper.srx.connection_tag | connection tag | keyword |
| juniper.srx.context_hit_rate | context hit rate | integer |
| juniper.srx.context_name | context name | keyword |
| juniper.srx.context_value | context value | keyword |
| juniper.srx.context_value_hit_rate | context value hit rate | integer |
| juniper.srx.ddos_application_name | ddos application name | keyword |
| juniper.srx.dpdk.port_number | integer | |
| juniper.srx.dpdk.port_state | integer | |
| juniper.srx.dpdk.swt_port_state | integer | |
| juniper.srx.dscp_value | apbr rule type | integer |
| juniper.srx.dst_nat_rule_name | dst nat rule name | keyword |
| juniper.srx.dst_nat_rule_type | dst nat rule type | keyword |
| juniper.srx.dst_vrf_grp | dst_vrf_grp | keyword |
| juniper.srx.elapsed_time | elapsed time | date |
| juniper.srx.encrypted | encrypted | keyword |
| juniper.srx.epoch_time | epoch time | date |
| juniper.srx.error_code | error_code | keyword |
| juniper.srx.error_message | error_message | keyword |
| juniper.srx.export_id | packet log id | integer |
| juniper.srx.feed_name | feed name | keyword |
| juniper.srx.file_category | file category | keyword |
| juniper.srx.file_hash_lookup | file hash lookup | keyword |
| juniper.srx.file_name | file name | keyword |
| juniper.srx.filename | filename | keyword |
| juniper.srx.first_forwarding_class | keyword | |
| juniper.srx.function_name | keyword | |
| juniper.srx.hostname | hostname | keyword |
| juniper.srx.icmp_type | icmp type | integer |
| juniper.srx.inbound_bytes | bytes from server | integer |
| juniper.srx.inbound_packets | packets from server | integer |
| juniper.srx.index | index | keyword |
| juniper.srx.index1 | keyword | |
| juniper.srx.index2 | keyword | |
| juniper.srx.ip_mon_reth_scan.trigger | keyword | |
| juniper.srx.kern_arp_addr_change.ip | ip | |
| juniper.srx.kern_arp_addr_change.mac1 | keyword | |
| juniper.srx.kern_arp_addr_change.mac2 | keyword | |
| juniper.srx.local_initiator | keyword | |
| juniper.srx.log_type | keyword | |
| juniper.srx.logical_system_name | logical system name | keyword |
| juniper.srx.malware_info | malware info | keyword |
| juniper.srx.message | mesagge | keyword |
| juniper.srx.message_type | message type | keyword |
| juniper.srx.mode | keyword | |
| juniper.srx.name | name | keyword |
| juniper.srx.nat_connection_tag | nat connection tag | keyword |
| juniper.srx.negotiation.err_msg | keyword | |
| juniper.srx.negotiation.message | keyword | |
| juniper.srx.negotiation.type | keyword | |
| juniper.srx.nested_application | nested application | keyword |
| juniper.srx.obj | url path | keyword |
| juniper.srx.occur_count | occur count | integer |
| juniper.srx.operational_status | keyword | |
| juniper.srx.outbound_bytes | bytes from client | integer |
| juniper.srx.outbound_packets | packets from client | integer |
| juniper.srx.packet_log_id | packet log id | integer |
| juniper.srx.peer_destination_address | peer destination address | ip |
| juniper.srx.peer_destination_port | peer destination port | integer |
| juniper.srx.peer_session_id | peer session id | keyword |
| juniper.srx.peer_source_address | peer source address | ip |
| juniper.srx.peer_source_port | peer source port | integer |
| juniper.srx.ping_test.name | keyword | |
| juniper.srx.ping_test.owner | keyword | |
| juniper.srx.policy_name | policy name | keyword |
| juniper.srx.process | process that generated the message | keyword |
| juniper.srx.profile | filter profile | keyword |
| juniper.srx.profile_name | profile name | keyword |
| juniper.srx.protocol | protocol | keyword |
| juniper.srx.protocol_id | protocol id | keyword |
| juniper.srx.protocol_name | protocol name | keyword |
| juniper.srx.reason | reason | keyword |
| juniper.srx.remote_responder | keyword | |
| juniper.srx.repeat_count | repeat count | integer |
| juniper.srx.roles | roles | keyword |
| juniper.srx.routing_instance | routing instance | keyword |
| juniper.srx.rtlog_conn_error.code | long | |
| juniper.srx.rtlog_conn_error.description | keyword | |
| juniper.srx.rtlog_conn_error.err_msg | keyword | |
| juniper.srx.rtlog_conn_error.major | long | |
| juniper.srx.rtlog_conn_error.minor | long | |
| juniper.srx.rtlog_conn_error.status | long | |
| juniper.srx.rtlog_conn_error.stream_name | keyword | |
| juniper.srx.rtslib_dfwsm.k_usr_d | keyword | |
| juniper.srx.rtslib_dfwsm.u_data | keyword | |
| juniper.srx.rule_name | rule name | keyword |
| juniper.srx.ruleebase_name | ruleebase name | keyword |
| juniper.srx.sample_sha256 | sample sha256 | keyword |
| juniper.srx.secure_web_proxy_session_type | secure web proxy session type | keyword |
| juniper.srx.service_name | service name | keyword |
| juniper.srx.session_flag | session flag | integer |
| juniper.srx.session_id | session id | keyword |
| juniper.srx.session_id_32 | session id 32 | keyword |
| juniper.srx.snmp_interface_index | keyword | |
| juniper.srx.src_nat_rule_name | src nat rule name | keyword |
| juniper.srx.src_nat_rule_type | src nat rule type | keyword |
| juniper.srx.src_vrf_grp | src_vrf_grp | keyword |
| juniper.srx.state | state | keyword |
| juniper.srx.status | status | keyword |
| juniper.srx.sub_category | sub category | keyword |
| juniper.srx.system.aux_spi | integer | |
| juniper.srx.system.direction | keyword | |
| juniper.srx.system.ike_version | integer | |
| juniper.srx.system.local | keyword | |
| juniper.srx.system.local_gateway | ip | |
| juniper.srx.system.local_id | keyword | |
| juniper.srx.system.local_ike_id | keyword | |
| juniper.srx.system.mode | keyword | |
| juniper.srx.system.remote | keyword | |
| juniper.srx.system.remote_gateway | keyword | |
| juniper.srx.system.remote_id | keyword | |
| juniper.srx.system.remote_ike_id | keyword | |
| juniper.srx.system.role | keyword | |
| juniper.srx.system.spi | keyword | |
| juniper.srx.system.traffic_selector | keyword | |
| juniper.srx.system.type | keyword | |
| juniper.srx.system.vpn | keyword | |
| juniper.srx.system.vr_id | keyword | |
| juniper.srx.tag | system log message tag, which uniquely identifies the message. | keyword |
| juniper.srx.temporary_filename | temporary_filename | keyword |
| juniper.srx.tenant_id | tenant id | keyword |
| juniper.srx.th | th | keyword |
| juniper.srx.threat_severity | threat severity | keyword |
| juniper.srx.time_count | time count | integer |
| juniper.srx.time_period | time period | integer |
| juniper.srx.time_scope | time scope | keyword |
| juniper.srx.timestamp | timestamp | date |
| juniper.srx.traffic_selector_name | keyword | |
| juniper.srx.tunnel_inspection | tunnel inspection | keyword |
| juniper.srx.tunnel_inspection_policy_set | tunnel inspection policy set | keyword |
| juniper.srx.type | type | keyword |
| juniper.srx.uplink_rx_bytes | uplink rx bytes | integer |
| juniper.srx.uplink_tx_bytes | uplink tx bytes | integer |
| juniper.srx.url | url domain | keyword |
| juniper.srx.username | username | keyword |
| juniper.srx.verdict_number | verdict number | integer |
| juniper.srx.verdict_source | verdict source | keyword |
| labels | Custom key/value pairs. Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword. Example: docker and k8s labels. |
object |
| log.file.device_id | ID of the device containing the filesystem where the file resides. | keyword |
| log.file.fingerprint | The sha256 fingerprint identity of the file when fingerprinting is enabled. | keyword |
| log.file.idxhi | The high-order part of a unique identifier that is associated with a file. (Windows-only) | keyword |
| log.file.idxlo | The low-order part of a unique identifier that is associated with a file. (Windows-only) | keyword |
| log.file.inode | Inode number of the log file. | keyword |
| log.file.path | Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn't read from a log file, do not populate this field. | keyword |
| log.file.vol | The serial number of the volume that contains a file. (Windows-only) | keyword |
| log.level | Original log level of the log event. If 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). Some examples are warn, err, i, informational. |
keyword |
| log.logger | 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. | keyword |
| log.offset | Byte offset of the log line within its file. | long |
| log.source.address | Source address of the syslog message. | keyword |
| log.syslog | The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164. | group |
| log.syslog.facility.code | The Syslog numeric facility of the log event, if available. According to RFCs 5424 and 3164, this value should be an integer between 0 and 23. | long |
| log.syslog.facility.name | The Syslog text-based facility of the log event, if available. | keyword |
| log.syslog.priority | Syslog numeric priority of the event, if available. According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191. | long |
| log.syslog.severity.code | The Syslog numeric severity of the log event, if available. If 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. |
long |
| log.syslog.severity.name | The Syslog numeric severity of the log event, if available. If 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. |
keyword |
| message | For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message. | match_only_text |
| network.application | When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name. For example, the original event identifies the network connection being from a specific web service in a https network connection, like facebook or twitter. The field value must be normalized to lowercase for querying. |
keyword |
| network.bytes | Total bytes transferred in both directions. If source.bytes and destination.bytes are known, network.bytes is their sum. |
long |
| network.community_id | 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. Learn more at https://github.com/corelight/community-id-spec. | keyword |
| network.direction | Direction of the network traffic. When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress". When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values "inbound", "outbound", "internal" or "external". Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers. | keyword |
| network.forwarded_ip | Host IP address when the source IP address is the proxy. | ip |
| network.iana_number | 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. | keyword |
| network.inner | Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.) | group |
| network.inner.vlan.id | VLAN ID as reported by the observer. | keyword |
| network.inner.vlan.name | Optional VLAN name as reported by the observer. | keyword |
| network.name | Name given by operators to sections of their network. | keyword |
| network.packets | Total packets transferred in both directions. If source.packets and destination.packets are known, network.packets is their sum. |
long |
| network.protocol | In the OSI Model this would be the Application Layer protocol. For example, http, dns, or ssh. The field value must be normalized to lowercase for querying. |
keyword |
| network.transport | Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) The field value must be normalized to lowercase for querying. | keyword |
| network.type | In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc The field value must be normalized to lowercase for querying. | keyword |
| network.vlan.id | VLAN ID as reported by the observer. | keyword |
| network.vlan.name | Optional VLAN name as reported by the observer. | keyword |
| observer.egress | Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. | group |
| observer.egress.interface.alias | Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. | keyword |
| observer.egress.interface.id | Interface ID as reported by an observer (typically SNMP interface ID). | keyword |
| observer.egress.interface.name | Interface name as reported by the system. | keyword |
| observer.egress.vlan.id | VLAN ID as reported by the observer. | keyword |
| observer.egress.vlan.name | Optional VLAN name as reported by the observer. | keyword |
| observer.egress.zone | Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. | keyword |
| observer.hostname | Hostname of the observer. | keyword |
| observer.ingress | Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. | group |
| observer.ingress.interface.alias | Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. | keyword |
| observer.ingress.interface.id | Interface ID as reported by an observer (typically SNMP interface ID). | keyword |
| observer.ingress.interface.name | Interface name as reported by the system. | keyword |
| observer.ingress.vlan.id | VLAN ID as reported by the observer. | keyword |
| observer.ingress.vlan.name | Optional VLAN name as reported by the observer. | keyword |
| observer.ingress.zone | Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc. | keyword |
| observer.ip | IP addresses of the observer. | ip |
| observer.mac | MAC addresses of the observer. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| observer.name | Custom name of the observer. This 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. If no custom name is needed, the field can be left empty. | keyword |
| observer.product | The product name of the observer. | keyword |
| observer.serial_number | Observer serial number. | keyword |
| observer.type | The type of the observer the data is coming from. There is no predefined list of observer types. Some examples are forwarder, firewall, ids, ips, proxy, poller, sensor, APM server. |
keyword |
| observer.vendor | Vendor name of the observer. | keyword |
| observer.version | Observer version. | keyword |
| organization.id | Unique identifier for the organization. | keyword |
| organization.name | Organization name. | keyword |
| organization.name.text | Multi-field of organization.name. |
match_only_text |
| package.architecture | Package architecture. | keyword |
| package.build_version | Additional information about the build version of the installed package. For example use the commit SHA of a non-released package. | keyword |
| package.checksum | Checksum of the installed package for verification. | keyword |
| package.description | Description of the package. | keyword |
| package.install_scope | Indicating how the package was installed, e.g. user-local, global. | keyword |
| package.installed | Time when package was installed. | date |
| package.license | License under which the package was released. Use a short name, e.g. the license identifier from SPDX License List where possible (https://spdx.org/licenses/). | keyword |
| package.name | Package name | keyword |
| package.path | Path where the package is installed. | keyword |
| package.reference | Home page or reference URL of the software in this package, if available. | keyword |
| package.size | Package size in bytes. | long |
| package.type | Type of package. This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar. | keyword |
| package.version | Package version | keyword |
| process.args | Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. | keyword |
| process.args_count | Length of the process.args array. This 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. | long |
| process.code_signature.exists | Boolean to capture if a signature is present. | boolean |
| process.code_signature.status | Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. | keyword |
| process.code_signature.subject_name | Subject name of the code signer | keyword |
| process.code_signature.trusted | Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. | boolean |
| process.code_signature.valid | Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. | boolean |
| process.command_line | Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. | wildcard |
| process.command_line.text | Multi-field of process.command_line. |
match_only_text |
| process.entity_id | Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. | keyword |
| process.executable | Absolute path to the process executable. | keyword |
| process.executable.text | Multi-field of process.executable. |
match_only_text |
| process.exit_code | The exit code of the process, if this is a termination event. The field should be absent if there is no exit code for the event (e.g. process start). | long |
| process.hash.md5 | MD5 hash. | keyword |
| process.hash.sha1 | SHA1 hash. | keyword |
| process.hash.sha256 | SHA256 hash. | keyword |
| process.hash.sha512 | SHA512 hash. | keyword |
| process.name | Process name. Sometimes called program name or similar. | keyword |
| process.name.text | Multi-field of process.name. |
match_only_text |
| process.parent.args | Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. | keyword |
| process.parent.args_count | Length of the process.args array. This 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. | long |
| process.parent.code_signature.exists | Boolean to capture if a signature is present. | boolean |
| process.parent.code_signature.status | Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. | keyword |
| process.parent.code_signature.subject_name | Subject name of the code signer | keyword |
| process.parent.code_signature.trusted | Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. | boolean |
| process.parent.code_signature.valid | Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. | boolean |
| process.parent.command_line | Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. | wildcard |
| process.parent.command_line.text | Multi-field of process.parent.command_line. |
match_only_text |
| process.parent.entity_id | Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. | keyword |
| process.parent.executable | Absolute path to the process executable. | keyword |
| process.parent.executable.text | Multi-field of process.parent.executable. |
match_only_text |
| process.parent.exit_code | The exit code of the process, if this is a termination event. The field should be absent if there is no exit code for the event (e.g. process start). | long |
| process.parent.hash.md5 | MD5 hash. | keyword |
| process.parent.hash.sha1 | SHA1 hash. | keyword |
| process.parent.hash.sha256 | SHA256 hash. | keyword |
| process.parent.hash.sha512 | SHA512 hash. | keyword |
| process.parent.name | Process name. Sometimes called program name or similar. | keyword |
| process.parent.name.text | Multi-field of process.parent.name. |
match_only_text |
| process.parent.pe.architecture | CPU architecture target for the file. | keyword |
| process.parent.pe.company | Internal company name of the file, provided at compile-time. | keyword |
| process.parent.pe.description | Internal description of the file, provided at compile-time. | keyword |
| process.parent.pe.file_version | Internal version of the file, provided at compile-time. | keyword |
| process.parent.pe.imphash | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. | keyword |
| process.parent.pe.original_file_name | Internal name of the file, provided at compile-time. | keyword |
| process.parent.pe.product | Internal product name of the file, provided at compile-time. | keyword |
| process.parent.pgid | Deprecated for removal in next major version release. This field is superseded by process.group_leader.pid. Identifier of the group of processes the process belongs to. |
long |
| process.parent.pid | Process id. | long |
| process.parent.start | The time the process started. | date |
| process.parent.thread.id | Thread ID. | long |
| process.parent.thread.name | Thread name. | keyword |
| process.parent.title | Process title. The 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. | keyword |
| process.parent.title.text | Multi-field of process.parent.title. |
match_only_text |
| process.parent.uptime | Seconds the process has been up. | long |
| process.parent.working_directory | The working directory of the process. | keyword |
| process.parent.working_directory.text | Multi-field of process.parent.working_directory. |
match_only_text |
| process.pe.architecture | CPU architecture target for the file. | keyword |
| process.pe.company | Internal company name of the file, provided at compile-time. | keyword |
| process.pe.description | Internal description of the file, provided at compile-time. | keyword |
| process.pe.file_version | Internal version of the file, provided at compile-time. | keyword |
| process.pe.imphash | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. | keyword |
| process.pe.original_file_name | Internal name of the file, provided at compile-time. | keyword |
| process.pe.product | Internal product name of the file, provided at compile-time. | keyword |
| process.pgid | Deprecated for removal in next major version release. This field is superseded by process.group_leader.pid. Identifier of the group of processes the process belongs to. |
long |
| process.pid | Process id. | long |
| process.start | The time the process started. | date |
| process.thread.id | Thread ID. | long |
| process.thread.name | Thread name. | keyword |
| process.title | Process title. The 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. | keyword |
| process.title.text | Multi-field of process.title. |
match_only_text |
| process.uptime | Seconds the process has been up. | long |
| process.working_directory | The working directory of the process. | keyword |
| process.working_directory.text | Multi-field of process.working_directory. |
match_only_text |
| registry.data.bytes | Original bytes written with base64 encoding. For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by lp_data. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values. |
keyword |
| registry.data.strings | Content when writing string types. Populated as an array when writing string data to the registry. For single string registry types (REG_SZ, REG_EXPAND_SZ), this should be an array with one string. For sequences of string with REG_MULTI_SZ, this array will be variable length. For numeric data, such as REG_DWORD and REG_QWORD, this should be populated with the decimal representation (e.g "1"). |
wildcard |
| registry.data.type | Standard registry type for encoding contents | keyword |
| registry.hive | Abbreviated name for the hive. | keyword |
| registry.key | Hive-relative path of keys. | keyword |
| registry.path | Full path, including hive, key and value | keyword |
| registry.value | Name of the value written. | keyword |
| related.hash | All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). | keyword |
| related.hosts | All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases. | keyword |
| related.ip | All of the IPs seen on your event. | ip |
| related.user | All the user names or other user identifiers seen on the event. | keyword |
| rule.author | Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. | keyword |
| rule.category | A categorization value keyword used by the entity using the rule for detection of this event. | keyword |
| rule.description | The description of the rule generating the event. | keyword |
| rule.id | A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. | keyword |
| rule.license | Name of the license under which the rule used to generate this event is made available. | keyword |
| rule.name | The name of the rule or signature generating the event. | keyword |
| rule.reference | Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert. | keyword |
| rule.ruleset | Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. | keyword |
| rule.uuid | A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. | keyword |
| rule.version | The version / revision of the rule being used for analysis. | keyword |
| server.address | 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. Then it should be duplicated to .ip or .domain, depending on which one it is. |
keyword |
| server.as.organization.name | Organization name. | keyword |
| server.as.organization.name.text | Multi-field of server.as.organization.name. |
match_only_text |
| server.bytes | Bytes sent from the server to the client. | long |
| server.domain | The domain name of the server system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
| server.ip | IP address of the server (IPv4 or IPv6). | ip |
| server.mac | MAC address of the server. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| server.nat.ip | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. | ip |
| server.nat.port | Translated port of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. | long |
| server.packets | Packets sent from the server to the client. | long |
| server.port | Port of the server. | long |
| server.registered_domain | The highest registered server domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| server.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| server.user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| server.user.email | User email address. | keyword |
| server.user.full_name | User's full name, if available. | keyword |
| server.user.full_name.text | Multi-field of server.user.full_name. |
match_only_text |
| server.user.group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| server.user.group.id | Unique identifier for the group on the system/platform. | keyword |
| server.user.group.name | Name of the group. | keyword |
| server.user.hash | Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used. |
keyword |
| server.user.id | Unique identifier of the user. | keyword |
| server.user.name | Short name or login of the user. | keyword |
| server.user.name.text | Multi-field of server.user.name. |
match_only_text |
| server.user.roles | Array of user roles at the time of the event. | keyword |
| service.ephemeral_id | Ephemeral identifier of this service (if one exists). This id normally changes across restarts, but service.id does not. |
keyword |
| service.id | Unique identifier of the running service. If the service is comprised of many nodes, the service.id should be the same for all nodes. This 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. Note 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. |
keyword |
| service.name | Name of the service data is collected from. The 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. In 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. |
keyword |
| service.node.name | Name of a service node. This 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. In 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. |
keyword |
| service.state | Current state of the service. | keyword |
| service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch. |
keyword |
| service.version | Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. | keyword |
| source.address | 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. Then it should be duplicated to .ip or .domain, depending on which one it is. |
keyword |
| source.as.number | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. | long |
| source.as.organization.name | Organization name. | keyword |
| source.as.organization.name.text | Multi-field of source.as.organization.name. |
match_only_text |
| source.bytes | Bytes sent from the source to the destination. | long |
| source.domain | The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. | keyword |
| source.geo.city_name | City name. | keyword |
| source.geo.continent_name | Name of the continent. | keyword |
| source.geo.country_iso_code | Country ISO code. | keyword |
| source.geo.country_name | Country name. | keyword |
| source.geo.location | Longitude and latitude. | geo_point |
| source.geo.name | User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation. | keyword |
| source.geo.region_iso_code | Region ISO code. | keyword |
| source.geo.region_name | Region name. | keyword |
| source.ip | IP address of the source (IPv4 or IPv6). | ip |
| source.mac | MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
| source.nat.ip | Translated ip of source based NAT sessions (e.g. internal client to internet) Typically connections traversing load balancers, firewalls, or routers. | ip |
| source.nat.port | Translated port of source based NAT sessions. (e.g. internal client to internet) Typically used with load balancers, firewalls, or routers. | long |
| source.packets | Packets sent from the source to the destination. | long |
| source.port | Port of the source. | long |
| source.registered_domain | The highest registered source domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| source.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| source.user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| source.user.email | User email address. | keyword |
| source.user.full_name | User's full name, if available. | keyword |
| source.user.full_name.text | Multi-field of source.user.full_name. |
match_only_text |
| source.user.group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| source.user.group.id | Unique identifier for the group on the system/platform. | keyword |
| source.user.group.name | Name of the group. | keyword |
| source.user.hash | Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used. |
keyword |
| source.user.id | Unique identifier of the user. | keyword |
| source.user.name | Short name or login of the user. | keyword |
| source.user.name.text | Multi-field of source.user.name. |
match_only_text |
| source.user.roles | Array of user roles at the time of the event. | keyword |
| span.id | Unique identifier of the span within the scope of its trace. A span represents an operation within a transaction, such as a request to another service, or a database query. | keyword |
| tags | List of keywords used to tag each event. | keyword |
| threat.framework | 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. | keyword |
| threat.tactic.id | The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) | keyword |
| threat.tactic.name | Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/) | keyword |
| threat.tactic.reference | The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) | keyword |
| threat.technique.id | The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) | keyword |
| threat.technique.name | The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) | keyword |
| threat.technique.name.text | Multi-field of threat.technique.name. |
match_only_text |
| threat.technique.reference | The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) | keyword |
| tls.cipher | String indicating the cipher used during the current connection. | keyword |
| tls.client.certificate | 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. |
keyword |
| tls.client.certificate_chain | 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. |
keyword |
| tls.client.hash.md5 | 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. | keyword |
| tls.client.hash.sha1 | 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. | keyword |
| tls.client.hash.sha256 | 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. | keyword |
| tls.client.issuer | Distinguished name of subject of the issuer of the x.509 certificate presented by the client. | keyword |
| tls.client.ja3 | A hash that identifies clients based on how they perform an SSL/TLS handshake. | keyword |
| tls.client.not_after | Date/Time indicating when client certificate is no longer considered valid. | date |
| tls.client.not_before | Date/Time indicating when client certificate is first considered valid. | date |
| tls.client.server_name | Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to destination.domain. |
keyword |
| tls.client.subject | Distinguished name of subject of the x.509 certificate presented by the client. | keyword |
| tls.client.supported_ciphers | Array of ciphers offered by the client during the client hello. | keyword |
| tls.curve | String indicating the curve used for the given cipher, when applicable. | keyword |
| tls.established | Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. | boolean |
| tls.next_protocol | 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. | keyword |
| tls.resumed | Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. | boolean |
| tls.server.certificate | 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. |
keyword |
| tls.server.certificate_chain | 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. |
keyword |
| tls.server.hash.md5 | 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. | keyword |
| tls.server.hash.sha1 | 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. | keyword |
| tls.server.hash.sha256 | 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. | keyword |
| tls.server.issuer | Subject of the issuer of the x.509 certificate presented by the server. | keyword |
| tls.server.ja3s | A hash that identifies servers based on how they perform an SSL/TLS handshake. | keyword |
| tls.server.not_after | Timestamp indicating when server certificate is no longer considered valid. | date |
| tls.server.not_before | Timestamp indicating when server certificate is first considered valid. | date |
| tls.server.subject | Subject of the x.509 certificate presented by the server. | keyword |
| tls.version | Numeric part of the version parsed from the original string. | keyword |
| tls.version_protocol | Normalized lowercase protocol name parsed from original string. | keyword |
| trace.id | Unique identifier of the trace. A trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services. | keyword |
| transaction.id | Unique identifier of the transaction within the scope of its trace. A transaction is the highest level of work measured within a service, such as a request to a server. | keyword |
| url.domain | Domain of the url, such as "www.elastic.co". In 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. If the URL contains a literal IPv6 address enclosed by [ and ] (IETF RFC 2732), the [ and ] characters should also be captured in the domain field. |
keyword |
| url.extension | The field contains the file extension from the original request url, excluding the leading dot. The file extension is only set if it exists, as not every url has a file extension. The leading period must not be included. For example, the value must be "png", not ".png". Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). | keyword |
| url.fragment | Portion of the url after the #, such as "top". The # is not part of the fragment. |
keyword |
| url.full | 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. |
wildcard |
| url.full.text | Multi-field of url.full. |
match_only_text |
| url.original | Unmodified original url as seen in the event source. Note 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. This field is meant to represent the URL as it was observed, complete or not. | wildcard |
| url.original.text | Multi-field of url.original. |
match_only_text |
| url.password | Password of the request. | keyword |
| url.path | Path of the request, such as "/search". | wildcard |
| url.port | Port of the request, such as 443. | long |
| url.query | The query field describes the query string of the request, such as "q=elasticsearch". The ? 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. |
keyword |
| url.registered_domain | The highest registered url domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk". | keyword |
| url.scheme | Scheme of the request, such as "https". Note: The : is not part of the scheme. |
keyword |
| url.top_level_domain | 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 example.com is "com". This value can be determined precisely with a list like the public suffix list (https://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". | keyword |
| url.username | Username of the request. | keyword |
| user.domain | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| user.email | User email address. | keyword |
| user.full_name | User's full name, if available. | keyword |
| user.full_name.text | Multi-field of user.full_name. |
match_only_text |
| user.group.domain | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. | keyword |
| user.group.id | Unique identifier for the group on the system/platform. | keyword |
| user.group.name | Name of the group. | keyword |
| user.hash | Unique user hash to correlate information for a user in anonymized form. Useful if user.id or user.name contain confidential information and cannot be used. |
keyword |
| user.id | Unique identifier of the user. | keyword |
| user.name | Short name or login of the user. | keyword |
| user.name.text | Multi-field of user.name. |
match_only_text |
| user.roles | Array of user roles at the time of the event. | keyword |
| user_agent.device.name | Name of the device. | keyword |
| user_agent.name | Name of the user agent. | keyword |
| user_agent.original | Unparsed user_agent string. | keyword |
| user_agent.original.text | Multi-field of user_agent.original. |
match_only_text |
| user_agent.version | Version of the user agent. | keyword |
| vulnerability.category | 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) This field must be an array. | keyword |
| vulnerability.classification | The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/) | keyword |
| vulnerability.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) | keyword |
| vulnerability.description.text | Multi-field of vulnerability.description. |
match_only_text |
| vulnerability.enumeration | The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/) | keyword |
| vulnerability.id | 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) | keyword |
| vulnerability.reference | A resource that provides additional information, context, and mitigations for the identified vulnerability. | keyword |
| vulnerability.report_id | The report or scan identification number. | keyword |
| vulnerability.scanner.vendor | The name of the vulnerability scanner vendor. | keyword |
| vulnerability.score.base | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Base scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentiality, integrity, and availability), and scope. For example (https://www.first.org/cvss/specification-document) | float |
| vulnerability.score.environmental | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Environmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (https://www.first.org/cvss/specification-document) | float |
| vulnerability.score.temporal | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Temporal scores cover an assessment for code maturity, remediation level, and confidence. For example (https://www.first.org/cvss/specification-document) | float |
| vulnerability.score.version | 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. CVSS 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) | keyword |
| vulnerability.severity | The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss) | keyword |
Example
{
"@timestamp": "2016-02-18T01:32:50.391Z",
"agent": {
"ephemeral_id": "54aa3cbe-60b4-41ae-9a50-c2f871846983",
"id": "3bf92588-2ea8-4747-8efa-294ffad051db",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.10.2"
},
"client": {
"ip": "192.168.1.100",
"port": 58071
},
"data_stream": {
"dataset": "juniper_srx.log",
"namespace": "ep",
"type": "logs"
},
"destination": {
"as": {
"number": 35908
},
"geo": {
"continent_name": "Asia",
"country_iso_code": "BT",
"country_name": "Bhutan",
"location": {
"lat": 27.5,
"lon": 90.5
}
},
"ip": "67.43.156.13",
"port": 80
},
"ecs": {
"version": "8.17.0"
},
"elastic_agent": {
"id": "3bf92588-2ea8-4747-8efa-294ffad051db",
"snapshot": false,
"version": "8.10.2"
},
"event": {
"action": "web_filter",
"agent_id_status": "verified",
"category": [
"network",
"malware"
],
"dataset": "juniper_srx.log",
"ingested": "2023-10-03T10:08:52Z",
"kind": "alert",
"outcome": "success",
"severity": 12,
"timezone": "+00:00",
"type": [
"info",
"denied",
"connection"
]
},
"input": {
"type": "tcp"
},
"juniper": {
"srx": {
"category": "cat1",
"process": "RT_UTM",
"profile": "uf1",
"reason": "BY_BLACK_LIST",
"tag": "WEBFILTER_URL_BLOCKED"
}
},
"log": {
"level": "warning",
"source": {
"address": "172.25.0.6:36430"
}
},
"observer": {
"name": "utm-srx550-b",
"product": "SRX",
"type": "firewall",
"vendor": "Juniper"
},
"process": {
"name": "RT_UTM"
},
"related": {
"hosts": [
"www.baidu.com"
],
"ip": [
"192.168.1.100",
"67.43.156.13"
],
"user": [
"user01"
]
},
"server": {
"ip": "67.43.156.13",
"port": 80
},
"source": {
"ip": "192.168.1.100",
"port": 58071,
"user": {
"name": "user01"
}
},
"tags": [
"juniper-srx",
"forwarded"
],
"url": {
"domain": "www.baidu.com",
"path": "/"
}
}
Changelog
| Version | Details | Minimum Kibana version |
|---|---|---|
| 1.27.0 | Enhancement (View pull request) Improve integration documentation. |
9.0.0 8.11.0 |
| 1.26.0 | Enhancement (View pull request) Preserve event.original on pipeline error. |
9.0.0 8.11.0 |
| 1.25.2 | Enhancement (View pull request) Generate processor tags and normalize error handler. |
9.0.0 8.11.0 |
| 1.25.1 | Enhancement (View pull request) Changed owners. |
9.0.0 8.11.0 |
| 1.25.0 | Enhancement (View pull request) Standardize user fields processing across integrations. |
9.0.0 8.11.0 |
| 1.24.0 | Enhancement (View pull request) Allow @custom pipeline access to event.original without setting preserve_original_event. |
9.0.0 8.11.0 |
| 1.23.0 | Enhancement (View pull request) Support stack version 9.0. |
9.0.0 8.0.0 |
| 1.22.1 | Bug fix (View pull request) Updated SSL description to be uniform and to include links to documentation. |
8.0.0 |
| 1.22.0 | Enhancement (View pull request) ECS version updated to 8.17.0. |
8.0.0 |
| 1.21.3 | Enhancement (View pull request) Populated event.outcome and event.category to system log on SSH login failure and added host.name field to system log. |
8.0.0 |
| 1.21.2 | Bug fix (View pull request) Use triple-brace Mustache templating when referencing variables in ingest pipelines. |
8.0.0 |
| 1.21.1 | Bug fix (View pull request) Use triple-brace Mustache templating when referencing variables in ingest pipelines. |
8.0.0 |
| 1.21.0 | Enhancement (View pull request) Update package spec to 3.0.3. |
8.0.0 |
| 1.20.1 | Enhancement (View pull request) Changed owners |
8.0.0 |
| 1.20.0 | Enhancement (View pull request) ECS version updated to 8.11.0. |
8.0.0 |
| 1.19.0 | Enhancement (View pull request) Improve 'event.original' check to avoid errors if set. |
8.0.0 |
| 1.18.1 | Bug fix (View pull request) Remove empty groups imported from ECS |
8.0.0 |
| 1.18.0 | Enhancement (View pull request) Adapt fields for changes in file system info |
8.0.0 |
| 1.17.1 | Bug fix (View pull request) Remove redundant regular expression quantifier. |
8.0.0 |
| 1.17.0 | Enhancement (View pull request) Update the package format_version to 3.0.0. |
8.0.0 |
| 1.16.2 | Bug fix (View pull request) Removing additional unused ECS field declarations. |
8.0.0 |
| 1.16.1 | Bug fix (View pull request) Removing unused ECS field declarations. |
8.0.0 |
| 1.16.0 | Enhancement (View pull request) ECS version updated to 8.10.0. |
8.0.0 |
| 1.15.0 | Enhancement (View pull request) Add tags.yml file so that integration's dashboards and saved searches are tagged with "Security Solution" and displayed in the Security Solution UI. |
8.0.0 |
| 1.14.1 | Bug fix (View pull request) Fix system logs grok |
8.0.0 |
| 1.14.0 | Enhancement (View pull request) Update package to ECS 8.9.0. |
8.0.0 |
| 1.13.1 | Bug fix (View pull request) Remove confusing error message tag prefix. |
8.0.0 |
| 1.13.0 | Enhancement (View pull request) Support system logs |
8.0.0 |
| 1.12.0 | Enhancement (View pull request) Update package to ECS 8.8.0. |
8.0.0 |
| 1.11.0 | Enhancement (View pull request) Update package-spec version to 2.7.0. |
8.0.0 |
| 1.10.0 | Enhancement (View pull request) Update package to ECS 8.7.0. |
8.0.0 |
| 1.9.1 | Enhancement (View pull request) Added categories and/or subcategories. |
8.0.0 |
| 1.9.0 | Enhancement (View pull request) Support newer logs without junos@ip |
8.0.0 |
| 1.8.0 | Enhancement (View pull request) Update package to ECS 8.6.0. |
8.0.0 |
| 1.7.0 | Enhancement (View pull request) Add udp_options to the UDP input. |
8.0.0 |
| 1.6.1 | Bug fix (View pull request) Remove duplicate fields. |
8.0.0 |
| 1.6.0 | Enhancement (View pull request) Update package to ECS 8.5.0. |
8.0.0 |
| 1.5.2 | Bug fix (View pull request) Remove duplicate field. |
8.0.0 |
| 1.5.1 | Enhancement (View pull request) Use ECS geo.location definition. |
8.0.0 |
| 1.5.0 | Enhancement (View pull request) Update package to ECS 8.4.0 |
8.0.0 |
| 1.4.1 | Enhancement (View pull request) Improve TCP, SSL config description and example. |
8.0.0 |
| 1.4.0 | Enhancement (View pull request) Update package to ECS 8.3.0. |
8.0.0 |
| 1.3.1 | Enhancement (View pull request) Add link to juniper documentation |
8.0.0 |
| 1.3.0 | Enhancement (View pull request) Add TLS and custom options support to TCP input |
8.0.0 |
| 1.2.0 | Enhancement (View pull request) Update to ECS 8.2 |
8.0.0 |
| 1.1.2 | Enhancement (View pull request) Add documentation for multi-fields |
8.0.0 |
| 1.1.1 | Bug fix (View pull request) Add Ingest Pipeline script to map IANA Protocol Numbers |
8.0.0 |
| 1.1.0 | Enhancement (View pull request) Update to ECS 8.0 |
8.0.0 |
| 1.0.1 | Bug fix (View pull request) Change test public IPs to the supported subset |
8.0.0 |
| 1.0.0 | Enhancement (View pull request) Initial release of new package split from oroginal Juniper package |
8.0.0 |