Cisco ASA Source
The Cisco ASA Source receives syslog data from Cisco ASA firewalls over UDP, TCP, or both. It parses messages that follow RFC 3164 and RFC 5424.
Type: Push | TLS Support: Yes | Event Breaker Support: No
Configure a Cisco ASA Source
- On the top bar, select Products, and then select Cribl Stream. Under Worker Groups, select a Worker Group. Next, you have two options:
- To configure via QuickConnect, navigate to Routing > QuickConnect. Select Add Source and select Cisco ASA from the list, choosing either Select Existing or Add New.
- To configure via the Routes, select Data > Sources. Select Cisco ASA. Next, select Add Source.
- In the New Source modal, configure the following under General Settings:
- Input ID: Enter a unique name to identify this Cisco ASA Source definition. If you clone this Source, Cribl Stream adds
-CLONEto the original Input ID. - Description: Optionally, enter a description.
- Address: Address to bind on. Defaults to
0.0.0.0, which listens on all IPv4 addresses. For IPv6, enter::or a specific address. - UDP port: UDP port number to listen on. Not required when the Source listens on TCP.
- TCP port: TCP port number to listen on. Not required when the Source listens on UDP.
- Input ID: Enter a unique name to identify this Cisco ASA Source definition. If you clone this Source, Cribl Stream adds
- Next, you can configure the following Optional Settings:
- Fields to keep: List of fields from the source data to retain and pass through. Supports wildcards. Defaults to
*, which keeps all fields. Fields that aren’t specified here are removed from the event. - Tags: Metadata tags used for categorization and filtering in the Cribl Stream UI. These tags aren’t added to processed events. Use a tab or hard return between tag names.
- Fields to keep: List of fields from the source data to retain and pass through. Supports wildcards. Defaults to
- Optionally, you can adjust the TLS, Persistent Queue, Processing, and Advanced settings, or Connected Destinations outlined in the sections below.
- Select Save, then Commit & Deploy.
TLS Settings (Server Side)
These settings apply only to TCP connections.
Enabled: Toggle on to enable Transport Layer Security (TLS) on this connection. Defaults to toggled off. When toggled on, configure the following settings.
Under Server Certificate, select a certificate from the store to auto-fill the paths, or enter them manually:
- Certificate: Select an existing certificate name from the drop-down or add a new certificate by selecting Create. See adding a certificate on a Worker Group for details.
- Certificate path: Enter the server path that contains certificates in Privacy Enhanced Mail (PEM) format. You can reference
$ENV_VARS. - Private key path: Enter the server path that contains the private key in PEM format. You can reference
$ENV_VARS. - Passphrase: Enter the passphrase used to decrypt the private key.
Under Mutual Authentication (mTLS):
- Authenticate client (mutual auth): Toggle on to require clients to present certificates. Defaults to toggled off. When toggled on, configure these settings:
- Trusted client CA path: Enter the server path that contains the certificate authority (CA) certificates to trust as the chain root when verifying a client’s identity.
- Validate client certificates: Toggle on to reject certificates that aren’t authorized by a CA in the Trusted client CA path or by another trusted CA. Defaults to toggled on.
- Common name: Enter a regex to match against the CN and SAN fields in the client certificate. Cribl Stream rejects clients unless it finds at least one match. Defaults to
/.*/.
Under TLS Version, reject clients using TLS versions below or above these thresholds:
- Minimum TLS version: Select the minimum TLS version to accept.
- Maximum TLS version: Select the maximum TLS version to accept.
Persistent Queue Settings
In the Persistent Queue Settings tab, you can optionally specify persistent queue storage, using the following controls. Persistent queue buffers and preserves incoming events when a downstream Destination has an outage or experiences backpressure.
Before enabling persistent queue, learn more about persistent queue behavior and how to optimize it with your system:
On Cribl-managed Cloud Workers (with an Enterprise plan), this tab exposes only the Enable persistent queue toggle. If enabled, PQ is automatically configured in
Always Onmode, with a maximum queue size of 1 GB disk space allocated per PQ-enabled Source, per Worker Process.The 1 GB limit is on uncompressed inbound data, and the queue does not perform any compression. This limit is not configurable. For configurable queue size, compression, mode, and other options below, use a hybrid Group.
All other settings described in this section apply to on-prem and hybrid deployments only.
Enable persistent queue: Default is toggled off. When toggled on:
Mode: Select a condition for engaging persistent queues.
Always On: This default option will always write events to the persistent queue, before forwarding them to the Cribl Stream data processing engine.Smart: This option will engage PQ only when the Source detects backpressure from the Cribl Stream data processing engine.Smartmode only engages when necessary, such as when a downstream Destination becomes blocked and the Buffer size limit reaches its limit. When persistent queue is set toSmartmode, Cribl Stream attempts to flush the queue when every new event arrives. The only time events stay in the buffer is when a downstream Destination becomes blocked.
Deprecation Notice
To improve data integrity, Smart mode is deprecated for Source persistent queue on hybrid and on-prem deployments. In January 2027, affected configurations will automatically migrate to Always On mode. Consider updating existing configurations to Always On mode prior to the automatic migration date. Before changing the configuration:
- Monitor your persistent queue usage so that you can allocate enough disk space.
- Before making changes to your persistent queue, remember to drain the queues first to avoid orphaned data.
- Verify that data routing and filtering behaves as expected in a test environment before rolling out the new configuration to production.
Buffer size limit (bytes): The maximum memory to buffer events before flushing them to persistent queue on disk. Enter a value with a unit suffix. For example: 64KB, 1MB, or 10MB. Spaces between the number and unit are allowed (such as 64 KB). Units are case-insensitive. Plain byte values (like 65536) are accepted, but decimals (like 0.5MB) are not. The valid range is 64KB to 10MB. Values outside this range are rounded to the nearest limit. Defaults to 1MB.
Deprecation Notice
The Buffer size limit (bytes) setting replaces the deprecated Buffer size limit (events) setting as of version 4.18.0 to provide more predictable memory management. For upgraded Worker Groups and Fleets, the new byte-based limit defaults to
1MB. Update your configurations to use the byte-based limit to ensure optimal memory stability.
Commit frequency: The number of events to send downstream before committing that Cribl Stream has read them. Defaults to 42.
File size limit: The maximum data volume to store in each queue file before closing it and (optionally) applying the configured Compression. Enter a numeral with units of KB, MB, and so on. If not specified, Cribl Stream applies the default 10 MB. When you save the configuration, File size limit must be greater than or equal to Buffer size limit (bytes). Cribl Stream rejects invalid combinations.
Queue size limit: The maximum amount of disk space that the queue is allowed to consume on each Worker Process. Once this limit is reached, this Source stops queueing data and applies the Queue-full behavior. Required, and defaults to 5 GB. Accepts positive numbers with units of KB, MB, GB, and so on. Can be set as high as 1 TB, unless you’ve configured a different Worker Process PQ size limit in Group or Fleet settings.
Queue file path: The location for the persistent queue files. Defaults to $CRIBL_HOME/state/queues. To this field’s specified path, Cribl Stream appends /<worker-id>/inputs/<input-id>.
Compression: Optional codec to compress the persisted data after a file closes. Defaults to None; Gzip is also available.
Queue-full behavior: Whether to block or drop events when the queue begins to exert backpressure. A queue begins to exert backpressure when the disk is low or at full capacity.
- Block (Default): Does not accept new data until the queue has capacity. When the sender supports backpressure signaling, Cribl Stream returns block signals to the sender.
- Drop new data: Discards incoming events while leaving the contents of the persistent queue unchanged.
In Cribl Stream 4.1 and newer, the Source persistent queue default Mode is
Always on, to best ensure events’ delivery. For details on optimizing this selection, see Optimize Source Persistent Queues.You can optimize Workers’ startup connections and CPU load at Group/Fleet settings > Worker Processes.
Processing Settings
Fields
In this section, you can define new fields or modify existing ones using JavaScript expressions, similar to the Eval function.
- The Field Name can either be a new field (unique within the event) or an existing field name to modify its value.
- The Value is a JavaScript expression (enclosed in quotes or backticks) to compute the field’s value (can be a constant). Select this field’s advanced mode icon (far right) if you’d like to open a modal where you can work with sample data and iterate on results.
This flexibility means you can:
- Add new fields to enrich the event.
- Modify existing fields by overwriting their values.
- Compute logic or transformations using JavaScript expressions.
Pre-Processing
Auto parse: Toggle on to detect each event’s Datatype and extract top-level fields from _raw before Source Fields and before the pre-processing Pipeline or Pack. The toggle is off by default. Because Fields runs after automatic parsing, values you add there take precedence over same-named fields extracted from _raw. For Datatypes that automatic parsing can detect, see the List of Stock v2 Datatypes. For field behavior, prevention of duplicate parsing, and performance considerations, see Automatic Parsing.
Pipeline: Select an existing Pipeline or Pack to process data from this Source before routing.
Advanced Settings
Single msg per UDP: Toggle on to treat received UDP packet data as a full syslog message. If toggled off (the default), Cribl Stream treats newlines within the packet as event delimiters.
Enable TCP load balancing: Toggle on to load balance TCP traffic across Worker Processes. This setting is available only when TCP port is set, and only in Cribl Stream Single-instance and Distributed deployments. For how the load balancer works, see TCP load balancing on the Syslog Source.
IP allowlist regex: Regex matching IP addresses that are permitted to send data. Defaults to .* (that is, all IPs).
Active connection limit: Maximum number of active connections allowed per Worker Process for TCP connections. Defaults to 1000. Set a lower value if connection storms are causing the Source to hang. Set 0 for unlimited connections.
TCP socket idle timeout (seconds): How long Cribl Stream waits before assuming that an inactive socket has timed out. After this time, the connection is closed. Leave at 0 for no inactive socket monitoring. Defaults to 0.
TCP forced socket termination timeout (seconds): How long the server waits after initiating a closure for a client to close its end of the connection. If the client doesn’t close the connection within this time, the server forcefully terminates the socket. Defaults to 30. Leave at 0 for no inactive socket monitoring.
TCP Socket max lifespan (seconds): The maximum duration a socket can remain open, even if active. This helps manage resources and mitigate issues caused by TCP pinning. Set to 0 to disable. Defaults to 0.
Buffer size limit (events): Maximum number of events to buffer when downstream is blocking. The buffer is only in memory, and it applies only to UDP. Defaults to 1000.
UDP socket buffer size (bytes): Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Minimum 256. Maximum 4294967295.
Setting this value affects OS memory utilization.
Default timezone: Timezone to assign to timestamps that omit timezone info. Defaults to local.
Environment: If you’re using GitOps, optionally use this field to specify a single Git branch on which to enable this configuration. If empty, the configuration is enabled everywhere.
Connected Destinations
Select Send to Routes to enable conditional routing, filtering, and cloning of this Source’s data via the Routing table.
Select QuickConnect to send this Source’s data to one or more Destinations via independent, direct connections.
What Fields to Expect
Cisco documents ASA syslog messages in ASA Syslog Messages.
Internal Fields
Cribl Stream uses a set of internal fields to assist in handling data for this Source.
Fields for this Source:
__srcIpPort: Identifies the sending socket asudp|ortcp|, followed by the IP address and port.__syslogFail:truewhen the message fails RFC 3164 or RFC 5424 validation.
Troubleshooting
The Source’s configuration modal has helpful tabs for troubleshooting:
Live Data: Try capturing live data to see real-time events as they are ingested. On the Live Data tab, click Start Capture to begin viewing real-time data.
Logs: Review and search the logs that provide detailed information about the ingestion process, including any errors or warnings that may have occurred.
You can also view the Monitoring page that provides a comprehensive overview of data volume and rate, helping you identify ingestion issues. Analyze the graphs showing events and bytes in/out over time.
Common Issues
“Either TCP or UDP port must be configured”
The Source has no listening port. Set UDP port, TCP port, or both under General Settings, and then select Save.