Arista NG Firewall Integration for Elastic
| Version | 1.6.0 (View all) |
| Subscription level What's this? |
Basic |
| Developed by What's this? |
Community |
| Ingestion method(s) | 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 Arista NG Firewall integration for Elastic enables you to collect and analyze logs and metrics from Arista NG Firewall (formerly Untangle). By ingesting event-driven logs and statistics into the Elastic Stack, you'll gain deep visibility into network security, traffic patterns, and system performance in real-time.
This integration is compatible with all current standard releases of Arista NG Firewall (formerly Untangle NG Firewall) that support remote syslog forwarding using the Events configuration menu.
This integration requires:
- Elastic Stack version
8.11.0or later for full ingestion, dashboard and field mapping support. - An active Elastic Agent enrolled in a Fleet policy.
This integration collects several categories of logs from Arista NG Firewall using the syslog protocol. You configure your Arista appliance to forward its events to the host running Elastic Agent. The agent listens for incoming data over TCP or UDP, processes the messages into the Elastic Common Schema (ECS), and maps them to the log data stream. This data stream captures firewall policy actions, security events, session information, web activity, and system metrics.
The Arista NG Firewall integration collects several categories of logs from Arista NG Firewall (formerly Untangle) using the syslog protocol. These events are processed and mapped to the Elastic Common Schema (ECS) within the log data stream.
This integration collects log messages of the following types:
- Firewall events: Records of firewall policy actions such as allow or block decisions, including source and destination IP addresses, ports, and rule IDs.
- Security events: Logs from the Intrusion Prevention System (IPS), including threat signatures and severity levels.
- Traffic and session logs: Detailed session information, including byte counts, session duration, and protocol metadata.
- Web and application logs: HTTP request and response details, including URLs, user agents, and Web Filter categorization events.
- Administrative logs: Audit trails for administrator logins, configuration modifications, and management actions.
- System metrics: Statistics for network interfaces and general system resource utilization.
Integrating Arista NG Firewall logs with the Elastic Stack provides visibility into your network security and operational status. You can use this integration for the following use cases:
- Security monitoring: Detect and respond to threats identified by the Intrusion Prevention System (IPS) and firewall policy violations.
- Network traffic analysis: Use Kibana dashboards to visualize network traffic patterns, identify bandwidth-heavy applications, and optimize network performance.
- Audit and compliance: Maintain a searchable record of administrative actions and configuration changes to meet compliance requirements.
- Troubleshooting: Investigate connectivity issues or policy misconfigurations by analyzing detailed session and firewall event logs.
To use this integration, you'll need the following vendor prerequisites:
- Administrative credentials for the Arista NG Firewall (Edge Threat Management) web interface to configure event forwarding.
- Network connectivity between the firewall and the Elastic Agent host. You must ensure that any intermediate firewalls allow traffic on the selected syslog port (it's
9010by default). - Enabled and active modules such as Web Filter, Intrusion Prevention, or Firewall on the Arista appliance to generate the relevant event data.
- The IP address or hostname of the machine running the Elastic Agent to configure the remote syslog target.
You'll also need the following Elastic prerequisites:
- Elastic Stack (Elasticsearch and Kibana) version
8.11.0or later. - An active Elastic Agent installed and enrolled in Fleet.
- The Arista NG Firewall integration added to an Elastic Agent policy.
- Port
9010(or your custom-configured port) open on the Elastic Agent host to accept incoming TCP/UDP syslog traffic.
Elastic Agent must be installed on a host that'll receive the syslog data from your Arista NG Firewall. For more details, check the Elastic Agent installation instructions. You can install only one Elastic Agent per host.
Elastic Agent is required to stream data from the syslog receiver and ship the data to Elastic, where the events will then be processed using the integration's ingest pipelines.
You need to configure your Arista NG Firewall to forward events to the Elastic Agent host. Follow these steps to enable and configure the forwarding service:
- Log in to the Arista NG Firewall administration interface.
- Navigate to Config > Events > Syslog from the main dashboard.
- Check the box for Enable Remote Syslog to activate the forwarding service.
- Configure the destination connection details for your Elastic Agent:
- Host: Enter the IP address or hostname of the machine running the Elastic Agent.
- Port: Enter the port number configured in the integration settings (default is
9010). - Protocol: Select either
UDPorTCPto match your intended Elastic Agent input type.
- Critical performance step: By default, a rule to "Send all events" might exist. It's strongly recommended to deactivate or delete this rule to prevent system instability due to high log volume.
- Click Add to create specific rules for the data streams required for this integration.
- For each rule, provide a Description (for example, "Elastic Firewall Logs") and select the Class from the dropdown menu. This integration supports the following classes:
AdminLoginEventFirewallEventHttpRequestEventHttpResponseEventIntrusionPreventionLogEventSessionEventSessionStatsEventSystemStatEventWebFilterEvent
- (Optional) Use Add Field under Conditions to further filter the events sent to Elastic.
- Click Done to save the individual rule settings.
- Click Save in the bottom-right corner of the main configuration window to apply the syslog changes to the firewall.
You can find more information about configuring syslog in the following Arista resources:
- How to create syslog event rules - Arista Networks
- Events Configuration - Arista Edge Threat Management Wiki
To add the integration to your Elastic Agent policy, follow these steps:
- In Kibana, navigate to Management > Integrations.
- Search for Arista NG Firewall and select the integration.
- Click Add Arista NG Firewall.
- Configure the integration by selecting an input type and providing the settings described below.
Choose the setup instructions that match the protocol you selected in the Arista NG Firewall configuration:
This input collects logs over a TCP socket. Configure the following settings:
- TCP host to listen on: The interface address to bind the TCP listener. Set to
0.0.0.0to listen on all interfaces. Default:localhost. - TCP Port to listen on: The port number to receive TCP syslog traffic. Default:
9010. - Preserve original event: If enabled, this preserves a raw copy of the original event in the
event.originalfield. Default:false. - Tags: Custom tags for the event. Default:
arista-ngfw,forwarded. - Processors: Optional Agent-side processors to filter or enhance data before ingestion. See Processors for details.
- Timezone: IANA time zone (for example,
America/New_York) or offset (for example,-05:00) for interpreting timestamps. Default:UTC. - Interface Mapping: Provide physical device names (for example,
eth0) and friendly aliases (for example,External) for your firewall interfaces.
This input collects logs over a UDP socket. Configure the following settings:
- UDP host to listen on: The interface address to bind the UDP listener. Set to
0.0.0.0to listen on all interfaces. Default:localhost. - UDP Port to listen on: The port number to receive UDP syslog traffic. Default:
9010. - Preserve original event: If enabled, this preserves a raw copy of the original event in the
event.originalfield. Default:false. - Tags: Custom tags for the event. Default:
arista-ngfw,forwarded. - Processors: Optional Agent-side processors to filter or enhance data before ingestion. See Processors for details.
- Timezone: IANA time zone or offset for timestamp interpretation. Default:
UTC. - Interface Mapping: Provide physical device names (for example,
eth1) and friendly aliases (for example,Internal) for your firewall interfaces.
After configuring the inputs, assign the integration to an agent policy and click Save and continue.
After the configuration is complete, follow these steps to verify data is flowing correctly from Arista NG Firewall to the Elastic Stack:
Trigger data flow on the Arista NG Firewall:
- Generate authentication event: Log out of the Arista NG Firewall administration UI and log back in to trigger an
AdminLoginEvent. - Generate web traffic: From a client device located behind the Arista firewall, browse to several different websites to generate
HttpRequestEventandWebFilterEventlogs. - Generate firewall event: Attempt to access a service that's explicitly blocked by a firewall rule to trigger a
FirewallEvent.
- Generate authentication event: Log out of the Arista NG Firewall administration UI and log back in to trigger an
Check the data in Kibana:
- Navigate to Analytics > Discover.
- Select the
logs-*data view. - In the search bar, enter the filter:
data_stream.dataset: "arista_ngfw.log". - Verify that logs appear. Expand a log entry and confirm these fields:
event.dataset(should bearista_ngfw.log)source.ipordestination.ipmessage(the raw log payload)
- Navigate to Analytics > Dashboards and search for "Arista NG Firewall" to view pre-built visualizations.
For help with Elastic ingest tools, check Common problems.
If you encounter issues while setting up or using the Arista NG Firewall integration, consider the following common configuration issues:
- Port mismatch: The Arista UI defaults to port
514for syslog, while the integration defaults to9010. You'll want to ensure both the appliance and the Kibana input configuration use the same port number. - Rules not enabled: Even if you configure the Syslog Server and set it to "Enabled" in the Arista interface, no data will flow until you add specific syslog rules in the lower section of the Events tab and check the Remote Syslog box for each rule.
- Binding failures: If the Elastic Agent can't bind to the configured host (like
localhost), the listener might fail to start. You should set thetcp_hostorudp_hostto0.0.0.0if you want to listen on all available network interfaces. - Network firewalls: If your Elastic Agent host has a local firewall like
ufworfirewalld, you'll need to explicitly allow incoming traffic on port9010. - Parsing failures: If you see logs in Kibana with
_grokparsefailureor_jsonparsefailuretags, verify the Arista appliance sends logs in the expected syslog format and check that no custom log prefixes are breaking the parser. - Timestamp mismatches: If logs aren't appearing when you expect, check for timezone offset issues and ensure the Timezone setting in the integration matches the timezone on your Arista NG Firewall appliance.
- Missing fields: If fields like
source.ipare missing, verify that the corresponding Arista module (such as the Firewall or Web Filter) is logging those details and that you've included the event class in your syslog rules.
To ensure optimal performance in high-volume environments, you should consider the following:
- Choose the appropriate transport protocol for your environment. The integration supports both
TCPandUDPfor syslog ingestion. For high-reliability environments where log loss is unacceptable,TCPis recommended despite slightly higher overhead.UDPprovides higher throughput with lower latency but doesn't guarantee delivery in congested networks. - Manage data volume at the source to prevent performance issues. To prevent performance degradation on both the Arista device and the Elastic Agent, you'll want to avoid using the
Send all eventsrule. Instead, configure specific syslog rules for only the necessary event classes such asFirewall,Session, andIPS. Filtering at the source significantly reduces the ingestion load and storage requirements. - Scale your Elastic Agent deployment for high-throughput environments. If you've got multiple firewall clusters, you can deploy multiple Elastic Agents behind a network load balancer to distribute traffic evenly. You'll want to place agents close to the data source to minimize latency and ensure dedicated agent nodes have sufficient CPU and memory allocations to handle peak traffic.
For more information on architectures that can be used for scaling this integration, check the Ingest Architectures documentation.
The following inputs are used by this integration:
These inputs can be used with this integration:
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 log data stream provides events from Arista NG Firewall of the following types: firewall traffic logs, security events, and system alerts.
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 |
| arista.bypassed | True if bypassed, false otherwise | boolean |
| arista.cpu.load.1 | Average CPU load over the last 1 minute | integer |
| arista.cpu.load.15 | Average CPU load over the last 15 minutes | integer |
| arista.cpu.load.5 | Average CPU load over the last 5 minutes | integer |
| arista.cpu.system.pct | Percentage of CPU used by system processes | float |
| arista.cpu.total.pct | Combined percentage of CPU used by system and user processes | float |
| arista.cpu.user.pct | Percentage of CPU used by user processes | float |
| arista.disk.free.bytes | Disk space available in bytes | integer |
| arista.disk.free.pct | Percentage of disk space available | float |
| arista.disk.total.bytes | Total disk space | integer |
| arista.disk.used.bytes | Disk space used in bytes | integer |
| arista.disk.used.pct | Percentage of disk space used | float |
| arista.entitled | The entitled status | boolean |
| arista.flagged | True if flagged, false otherwise | boolean |
| arista.hosts.active | Number of hosts currently active | integer |
| arista.interface.id | The ID of the network interface | integer |
| arista.memory.buffers | Number of memory buffers used | integer |
| arista.memory.cache.bytes | Memory cached in bytes | integer |
| arista.memory.free.bytes | Memory free in bytes | integer |
| arista.memory.free.pct | Percentage of memory free | float |
| arista.memory.swap.free.bytes | Swap memory free in bytes | integer |
| arista.memory.swap.free.pct | Percentage of swap memory free | float |
| arista.memory.swap.total.bytes | Total swap memory in bytes | integer |
| arista.memory.swap.used.bytes | Swap memory used in bytes | integer |
| arista.memory.swap.used.pct | Percentage of swap memory used | float |
| arista.memory.total.bytes | Total memory in bytes | integer |
| arista.memory.used.bytes | Memory used in bytes | integer |
| arista.memory.used.pct | Percentage of memory used | float |
| arista.policy.id | The firewall policy applied to the current event | integer |
| arista.policy.rule_id | The firewall policy rule responsible for assigning the current event to its policy | integer |
| arista.received.bytes | Bytes received since the last metric was reported | integer |
| arista.received.rate | The rate in bytes of network traffic being received | float |
| arista.transmitted.bytes | Bytes transmitted since the last metric was reported | integer |
| arista.transmitted.rate | The rate in bytes of network traffic being transmitted | float |
| 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.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.port | Port of the client. | long |
| client.user.name | Short name or login of the user. | keyword |
| client.user.name.text | Multi-field of client.user.name. |
match_only_text |
| 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.availability_zone | Availability zone in which this host is running. | 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 | Name of the project in Google Cloud. | keyword |
| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
| cloud.region | Region in which this host is running. | keyword |
| container.id | Unique container id. | keyword |
| container.image.name | Name of the image the container was built on. | keyword |
| container.labels | Image labels. | object |
| container.name | Container name. | 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_code | Two-letter code representing continent's 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.postal_code | Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. | keyword |
| destination.geo.region_iso_code | Region ISO code. | keyword |
| destination.geo.region_name | Region name. | keyword |
| destination.geo.timezone | The time zone of the location, such as IANA time zone name. | keyword |
| destination.ip | IP address of the destination (IPv4 or IPv6). | ip |
| 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.user.name | Short name or login of the user. | keyword |
| destination.user.name.text | Multi-field of destination.user.name. |
match_only_text |
| 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.response_code | The DNS response code. | 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.message | Error message. | match_only_text |
| 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.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.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 |
| file.hash.sha256 | SHA256 hash. | keyword |
| file.name | Name of the file including the extension, without the directory. | 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.size | File size in bytes. Only relevant when file.type is "file". |
long |
| 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. | keyword |
| host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. |
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.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. |
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 |
| 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.bytes | Total size in bytes of the response (body and headers). | long |
| http.response.status_code | HTTP response status code. | long |
| input.type | Input type. | 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.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.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.offset | Offset of the entry in the log file. | long |
| log.source.address | Source address from which the log event was read / sent from. | keyword |
| 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.hostname | The hostname, FQDN, or IP of the machine that originally sent the Syslog message. This is sourced from the hostname field of the syslog header. Depending on the environment, this value may be different from the host that handled the event, especially if the host handling the events is acting as a collector. | 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.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.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 |
| 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.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.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.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.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.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 |
| process.name | Process name. Sometimes called program name or similar. | keyword |
| process.name.text | Multi-field of process.name. |
match_only_text |
| process.pid | Process id. | long |
| 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.category | A categorization value keyword used by the entity using the rule for detection of this 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.name | The name of the rule or signature generating the event. | 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 |
| 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.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.port | Port of the server. | long |
| server.user.name | Short name or login of the user. | keyword |
| server.user.name.text | Multi-field of server.user.name. |
match_only_text |
| 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 |
| 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_code | Two-letter code representing continent's 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.postal_code | Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. | keyword |
| source.geo.region_iso_code | Region ISO code. | keyword |
| source.geo.region_name | Region name. | keyword |
| source.geo.timezone | The time zone of the location, such as IANA time zone name. | keyword |
| source.ip | IP address of the source (IPv4 or IPv6). | ip |
| 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.user.group.name | Name of the group. | 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 |
| tags | List of keywords used to tag each event. | 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.subdomain | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". 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 |
| 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.email | User email address. | 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_agent.original | Unparsed user_agent string. | keyword |
| user_agent.original.text | Multi-field of user_agent.original. |
match_only_text |
Example
{
"@timestamp": "2023-05-19T17:52:37.962Z",
"network": {
"direction": "outbound",
"iana_number": 17,
"transport": "udp"
},
"host": {
"hostname": "Host1",
"name": "Host1"
},
"event": {
"entitled": true,
"category": [
"session"
],
"original": "\u003c174\u003eMay 19 11:52:37 INFO uvm[0]: {\"entitled\":true,\"protocol\":17,\"hostname\":\"Host1\",\"CServerPort\":9930,\"protocolName\":\"UDP\",\"serverLatitude\":37.751,\"localAddr\":\"10.0.0.10\",\"class\":\"class com.untangle.uvm.app.SessionEvent\",\"SServerAddr\":\"18.214.195.29\",\"remoteAddr\":\"18.214.195.29\",\"serverIntf\":1,\"CClientAddr\":\"10.0.0.10\",\"serverCountry\":\"US\",\"sessionId\":110221863965041,\"SClientAddr\":\"66.113.13.6\",\"clientCountry\":\"XL\",\"policyRuleId\":0,\"CClientPort\":59881,\"timeStamp\":\"2023-05-19 11:52:37.962\",\"serverLongitude\":-97.822,\"clientIntf\":2,\"policyId\":1,\"SClientPort\":59881,\"bypassed\":false,\"SServerPort\":9930,\"CServerAddr\":\"18.214.195.29\",\"tagsString\":\"\"}",
"module": "arista_ngfw",
"kind": "event",
"dataset": "arista_ngfw.log",
"ingested": "2023-05-19T17:52:39Z",
"id": 110221863965041
},
"observer": {
"product": "Arista NG Firewall",
"type": "firewall",
"hostname": "arista1.contoso.com",
"name": "arista1",
"vendor": "Arista"
},
"log": {
"level": "informational",
"syslog": {
"severity": {
"code": 6,
"name": "Informational"
},
"facility": {
"code": 21,
"name": "Local 5"
},
"priority": 174
}
},
"source": {
"ip": "10.0.0.10",
"domain": "Host1.contoso.com",
"port": 59881,
"geo": {}
},
"related": {
"ip": [
"18.214.195.29",
"10.0.0.10"
],
"hosts": [
"EC2-18-214-195-29",
"Host1",
"arista1"
]
},
"tags": [],
"destination": {
"ip": "18.214.195.29",
"domain": "EC2-18-214-195-29.COMPUTE-1.AMAZONAWS.COM",
"port": 9930,
"geo": {
"city_name": "Ashburn",
"region_name": "Virginia",
"timezone": "America/New_York",
"region_iso_code": "VA",
"country_name": "United States",
"country_iso_code": "US",
"postal_code": "20149",
"continent_code": "NA",
"location": {
"lon": -77.4903,
"lat": 39.0469
}
}
}
}
For more information about Arista NG Firewall configuration and event management, refer to these vendor resources:
- Arista Events Configuration Wiki
- Arista Edge Threat Management - Official Product Page
- How to create syslog event rules - Arista Networks
Changelog
| Version | Details | Minimum Kibana version |
|---|---|---|
| 1.6.0 | Enhancement (View pull request) Update documentation for the integration. |
9.0.0 8.11.0 |
| 1.5.0 | Enhancement (View pull request) Preserve event.original on pipeline error. |
9.0.0 8.11.0 |
| 1.4.2 | Enhancement (View pull request) Generate processor tags and normalize error handler. |
9.0.0 8.11.0 |
| 1.4.1 | Enhancement (View pull request) Changed owners. |
9.0.0 8.11.0 |
| 1.4.0 | Enhancement (View pull request) Support stack version 9.0. |
9.0.0 8.11.0 |
| 1.3.0 | Enhancement (View pull request) ECS version updated to 8.17.0. |
8.11.0 |
| 1.2.1 | Bug fix (View pull request) Correct Grok pattern due to change in Syslog message format. |
8.11.0 |
| 1.2.0 | Enhancement (View pull request) Allow @custom pipeline access to event.original without setting preserve_original_event. |
8.11.0 |
| 1.1.0 | Enhancement (View pull request) Update package spec to 3.0.3. |
8.10.1 |
| 1.0.1 | Enhancement (View pull request) Changed owners |
8.10.1 |
| 1.0.0 | Enhancement (View pull request) Release package as GA. |
8.10.1 |
| 0.10.0 | Enhancement (View pull request) Add dashboards to integration |
8.10.1 |
| 0.9.0 | Enhancement (View pull request) ECS version updated to 8.11.0. |
8.6.2 |
| 0.8.0 | Enhancement (View pull request) Improve 'event.original' check to avoid errors if set. |
8.6.2 |
| 0.7.1 | Bug fix (View pull request) Fix mapping of empty groups imported from ECS |
8.6.2 |
| 0.7.0 | Enhancement (View pull request) Set 'community' owner type. |
8.6.2 |
| 0.6.0 | Enhancement (View pull request) ECS version updated to 8.10.0. |
8.6.2 |
| 0.5.0 | Enhancement (View pull request) The format_version in the package manifest changed from 2.11.0 to 3.0.0. Removed dotted YAML keys from package manifest. Added 'owner.type: elastic' to package manifest. |
8.6.2 |
| 0.4.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.6.2 |
| 0.3.0 | Enhancement (View pull request) Add parsing for network.bytes and network.packets |
8.6.2 |
| 0.2.0 | Enhancement (View pull request) Update package to ECS 8.9.0. |
8.6.2 |
| 0.1.2 | Bug fix (View pull request) Fix interface variables in manifest, and correct duplicate _conf fields |
8.6.2 |
| 0.1.1 | Bug fix (View pull request) Fix bugs in default ingest pipeline |
8.6.2 |
| 0.1.0 | Enhancement (View pull request) Add support for session stats events |
8.6.2 |
| 0.0.1 | Enhancement (View pull request) Initial draft of the package |
8.6.2 |