FortiSIEM Destination
The FortiSIEM Destination sends newline-delimited JSON (NDJSON) events to a FortiSIEM node. Cribl Stream posts each batch to /rawupload with the routing query parameters FortiSIEM uses to identify the log source.
Type: Streaming | TLS Support: Yes | PQ Support: Yes
Configure FortiSIEM to Receive Events
In FortiSIEM, prepare an HTTP(S) POST ingestion endpoint and an HTTP Basic username and password. The FortiSIEM guide for ingesting JSON events over HTTP(S) POST describes how to create that account and where the node accepts uploads.
- The upload path is
/rawuploadon the FortiSIEM node. Enter the node’s base URL in FortiSIEM URL. Cribl Stream adds/rawupload. - Create the username and password that this Destination sends with HTTP Basic authentication. Store them in the credentials secret you select under Authentication.
- Choose the vendor, model, reporting IP address, and reporting device name that identify the log source. Enter those values in Reporting Vendor, Reporting Model, Reporting IP, and Reporting Device Name.
Configure a FortiSIEM Destination
- 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 Destination and select FortiSIEM from the list, choosing either Select Existing or Add New.
- To configure via the Routes, select Data > Destinations. Select Add Destination, and then select FortiSIEM.
- In the New Destination modal, configure the following under General Settings:
- Output ID: Enter a unique name to identify this Destination definition. If you clone this Destination, Cribl Stream adds
-CLONEto the original Output ID. - Description: Enter a description for this Destination.
- FortiSIEM URL: Required. Enter the base URL of the FortiSIEM node, for example
https://fortisiem.example. The URL must start withhttp://orhttps://. Cribl Stream replaces any path in this URL with/rawupload. You can bind this field to a variable. - Reporting Vendor: Required. Enter the vendor of the product that generated the logs. FortiSIEM receives this value as the
vendorquery parameter. You can bind this field to a variable. - Reporting Model: Required. Enter the model of the product that generated the logs. FortiSIEM receives this value as the
modelquery parameter. You can bind this field to a variable. - Reporting IP: Required. Enter the reporting device IP address, which is the source of the logs. The value must be a valid IPv4 or IPv6 address. FortiSIEM receives it as the
reptIpquery parameter. You can bind this field to a variable. - Reporting Device Name: Required. Enter the reporting device hostname. FortiSIEM receives this value as the
reptNamequery parameter. You can bind this field to a variable.
- Output ID: Enter a unique name to identify this Destination definition. If you clone this Destination, Cribl Stream adds
- Under Optional Settings, configure the following:
- Backpressure behavior: Select whether to block, drop, or queue events when all receivers are exerting backpressure. Defaults to
Block. Set this toPersistent Queueto show Persistent Queue Settings. - Tags: Add tags that you can use to filter and group Destinations. These tags aren’t added to processed events. Use a tab or hard return between tag names.
- Backpressure behavior: Select whether to block, drop, or queue events when all receivers are exerting backpressure. Defaults to
- Under Authentication, select the credentials secret for HTTP Basic authentication. See Authentication.
- Optionally, adjust the TLS, Processing, Retries, and Advanced settings. Persistent Queue Settings appear when Backpressure behavior is
Persistent Queue. - Select Save, then Commit & Deploy.
- Use the Test tab in the Destination configuration modal to send a test event. In FortiSIEM, confirm that the node accepts the upload.
TLS Settings (Client Side)
Use TLS: Defaults to toggled on. This setting controls the client TLS options below. Encrypted delivery uses an https:// FortiSIEM URL. An http:// URL stays unencrypted. When Use TLS is toggled on, configure the following settings.
Under Server Validation, configure how this client verifies the remote server’s identity:
- Server name (SNI): Enter the host name for the Server Name Indication (SNI) TLS extension. The value must be a host name, not an IP address.
- Trusted server CA path: Enter the path on the Worker Node that contains the CA certificates in Privacy Enhanced Mail (PEM) format to trust as the chain root. You can reference
$ENV_VARS.
Under Mutual Authentication (mTLS):
- 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. Selecting a certificate fills the paths below.
- Certificate path (mutual auth): Enter the path on the Worker Node that contains certificates in PEM format. You can reference
$ENV_VARS. - Private key path (mutual auth): Enter the path on the Worker Node that contains the private key in PEM format. You can reference
$ENV_VARS. - Passphrase: Enter the passphrase used to decrypt the private key.
Under TLS Version, reject connections that use TLS versions below or above these thresholds:
- Minimum TLS version: Select the minimum TLS version to use. Selecting
TLSv1orTLSv1.1shows a deprecation warning. - Maximum TLS version: Select the maximum TLS version to use.
Authentication
Authentication type: HTTP Basic authentication is the only method. The value is Basic (credentials secret).
- Basic (credentials secret): This option shows a required Credentials secret field. Select a stored credentials secret that contains the FortiSIEM username and password. Cribl Stream sends them in the
Authorizationheader. Choose Select local secret or Select global secret, select a credentials secret, or select Create credentials secret. See Create and manage secrets and Global secrets.
Persistent Queue Settings
The Persistent Queue Settings tab displays when the Backpressure behavior option in General settings is set to Persistent Queue. 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:
- About Persistent Queues
- Optimize Destination Persistent Queues
- About Destination Backpressure Triggers
Some of these settings might not appear if you set the persistent queue storage mode to Network filesystem or AWS S3 at the Worker Group level (Worker Group Settings > System > PQ Storage). When using these storage types, this behavior is managed at the Worker Group level. See Worker Group PQ Storage Fields for more information.
On Cribl-managed Cloud Workers (with an Enterprise plan), this tab exposes only the Mode and Backpressure duration limit settings and the destructive Clear Persistent Queue button (described at the end of this section). A maximum queue size of 1 GB disk space is automatically allocated per PQ-enabled Destination, per Worker Process. The 1 GB limit is on outbound uncompressed data, and no compression is applied to the queue.
This limit is not configurable. If the queue fills up, Cribl Stream blocks outbound data. To configure the queue size, compression, queue-full fallback behavior, and other options below, use a hybrid Group.
Mode: Use this menu to select when Cribl Stream engages the persistent queue in response to backpressure events from this Destination. The options are:
| Mode | Description |
|---|---|
| Error | Queues and stores data on a disk when the Destination is unavailable or in an error state. |
| Backpressure | Queues and stores data to a disk when it detects backpressure from the Destination until the backpressure event resolves. |
| Always On | Cribl Stream immediately queues and stores all data on a disk for all events, even when there is no backpressure. |
If a Worker/Edge Node starts with an invalid Mode setting, it automatically switches to Error mode. This might happen if the Worker/Edge Node is running a version that does not support other modes (older than 4.9.0), or if it encounters a nonexistent value in YAML configuration files.
File size limit: The maximum data volume to store in each queue file before closing it. Enter a numeral with units of KB, MB, and so on. Defaults to 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 can consume on each Worker Process. When the queue reaches this limit, the Destination stops queueing data and applies the Queue-full behavior. Defaults to 5 GB. This field accepts positive numbers with units of KB, MB, GB, and so on. You can set it as high as 1 TB, unless you’ve configured a different Worker Process PQ size limit on the Worker Group/Fleet Settings page.
Queue file path: The location for the persistent queue files. Defaults to $CRIBL_HOME/state/queues. Cribl Stream appends /<worker-id>/<output-id> to this value.
Compression: Set the codec to use when compressing the persisted data after closing a file. 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. This setting has two options:
- Block: The output will refuse to accept new data until the receiver is ready. The system will return block signals back to the sender.
- Drop new data: Discard all new events until the backpressure event has resolved and the receiver is ready.
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.
Backpressure duration limit: Displays when Mode is set to Backpressure. Controls how long (in seconds) a Destination must experience backpressure before Cribl Stream queues data to persistent storage. Defaults to 30 seconds. Lowering this limit strengthens data loss prevention, while raising it helps prevent unnecessary queue activation in environments with frequent, short network interruptions.
Strict ordering: Toggle on (default) to enable FIFO (first in, first out) event forwarding, ensuring Cribl Stream sends earlier queued events first when receivers recover. The persistent queue flushes every 10 seconds in this mode. Toggle off to prioritize new events over queued events, configure a custom drain rate for the queue, and display this option:
- Drain rate limit (EPS): Optionally, set a throttling rate (in events per second) on writing from the queue to receivers. (The default
0value disables throttling.) Throttling the queue drain rate can boost the throughput of new and active connections by reserving more resources for them. You can further optimize Worker startup connections and CPU load in the Worker Processes settings.
Clear Persistent Queue: For Cloud Enterprise only, select this button if you want to delete the files that are currently queued for delivery to this Destination. If you select this button, a confirmation modal appears. Clearing the queue frees up disk space by permanently deleting the queued data, without delivering it to downstream receivers. This button only appears after you define the Output ID.
Use the Clear Persistent Queue button with caution to avoid data loss. See How to Safely Disable and Clear Persistent Queues for more information.
Processing Settings
Post-Processing
Pipeline: Select a Pipeline or Pack to process data before sending it.
System fields: A list of fields to automatically add to events that use this output. By default, includes cribl_pipe (identifying the Cribl Stream Pipeline that processed the event). Supports wildcards. Available fields include:
cribl_host- Worker Node that processed the event.cribl_input- Source that processed the event.cribl_output- Destination that processed the event.cribl_pipe- Pipeline that processed the event.cribl_route- Route (or QuickConnect) that processed the event.cribl_wp- Worker Process that processed the event.cribl_group- Worker Group that processed the event.cribl_mode- Distributed mode of the instance that processed the event.
Retries
Honor Retry-After header and Retry timed-out HTTP requests default to toggled on. The Settings for failed HTTP requests table lists 408, 429, 500, 502, 503, 504, and 509. The Pre-backoff interval (ms) is 1000 for 429 and 250 for the other codes. For timed-out requests, the pre-backoff interval is 1000, the backoff multiplier is 2, and the backoff limit is 10000. 401 and 403 aren’t in that default table. Cribl Stream retries them when the response includes a Retry-After header and Honor Retry-After header is toggled on, or when you add 401 or 403 to Settings for failed HTTP requests.
Honor Retry-After header: Toggle on to honor a Retry-After header, provided that the header specifies a delay no longer than 180 seconds. Cribl Stream/Edge limits the delay to 180 seconds even if the Retry-After header specifies a longer delay. Any Retry-After header received takes precedence over all other options configured in the Retries section. Toggle off to ignore all Retry-After headers.
Default Retry Behavior: By default, Cribl Stream/Edge applies predefined retry strategies for certain failed requests to the Destination using an exponential backoff algorithm. You can override these settings by manually configuring the retry behavior for a particular error code.
To retry requests, Cribl Stream/Edge applies the following rules by default:
| Status Code | Action |
|---|---|
Any in the 1xx, 3xx series | Drop the request |
408, 429 errors | Retry in memory or persistent queue if enabled, and initiate backpressure after limit is reached |
Any other 4xx series | Drop the request |
Any 5xx series | Retry in memory or persistent queue if enabled, and initiate backpressure after limit is reached |
By default, any 429 (Too Many Requests) response that is not listed in the retry settings is treated as a non-retryable 4xx error and dropped. If you want 429 responses retried, ensure 429 is included in the Settings for failed HTTP requests.
Settings for failed HTTP requests: You can also manually configure Cribl Stream/Edge to automatically retry requests that receive particular HTTP response status codes.
Upon receiving a response code that’s on the list, Cribl Stream/Edge first waits for a set time interval called the Pre-backoff interval and then begins retrying the request. Time between retries increases based on an exponential backoff algorithm whose base is the Backoff multiplier, until the backoff multiplier reaches the Backoff limit (ms). At that point, Cribl Stream/Edge continues retrying the request without increasing the time between retries any further.
If the sender (which manages the connection to the Destination) is at capacity, it will not accept any incoming events. These incoming events originate internally from a previous stage of the data flow when Destinations send outbound requests to their respective external services, and they include retry requests and new requests. Any events that were already in transit when the sender reached capacity will continue to be processed downstream.
Sender capacity is freed up when an outgoing request succeeds or encounters a non-retryable error. When the sender has available capacity again, it will resume accepting incoming events. This capacity management is influenced by the number of active connections and configured limits, such as concurrency and buffer sizes. If a Pipeline sends events faster than the Destination can process, the buffers may fill up, leading to backpressure and Sender at capacity warnings. This backpressure prevents the sender from accepting additional requests until capacity is restored.
For each response code you want to add to the list, select Add Setting and configure the following settings:
- HTTP status code: A response code that indicates a failed request, for example
429 (Too Many Requests)or503 (Service Unavailable). - Pre-backoff interval (ms): The amount of time to wait before beginning retries, in milliseconds. Defaults to
1000(one second). - Backoff multiplier: The base for the exponential backoff algorithm. A value of
2(the default) means that Cribl Stream/Edge will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on. - Backoff limit (ms): The maximum backoff interval Cribl Stream/Edge should apply for its final retry, in milliseconds. Default (and minimum) is
10,000(10 seconds); maximum is180,000(180 seconds, or 3 minutes).
Retry timed-out HTTP requests: Toggle on to automatically retry requests that have timed out and display the following settings for configuring retry behavior:
- Pre-backoff interval (ms): The amount of time to wait before beginning retries, in milliseconds. Defaults to
1000(one second). - Backoff multiplier: The base for the exponential backoff algorithm. A value of
2(the default) means that Cribl Stream/Edge will retry after 2 seconds, then 4 seconds, then 8 seconds, and so on. - Backoff limit (ms): The maximum backoff interval Cribl Stream/Edge should apply for its final retry, in milliseconds. Default (and minimum) is
10,000(10 seconds); maximum is180,000(180 seconds, or 3 minutes).
Advanced Settings
Validate server certs: Toggle on to reject certificates that aren’t authorized by a CA in the Trusted server CA path, or by another trusted CA. Defaults to toggled on.
Round-robin DNS: Toggle on to use each IP address that DNS returns for the endpoint, in the order returned. Defaults to toggled off.
Keep alive: Toggle on to send Keep-Alive headers and reuse the connection. Defaults to toggled on. Toggle off to close the connection after each request.
Request timeout: Enter how long, in seconds, Cribl Stream waits for a request to complete before aborting it. Defaults to 30.
Request concurrency: Enter the maximum number of concurrent requests per Worker Process. When Cribl Stream reaches this limit, it throttles traffic to FortiSIEM. Defaults to 5. The minimum is 1 and the maximum is 32.
Body size limit (KB): Enter the maximum size of the request body. Defaults to 4096. The minimum is 1024 and the maximum is 512000. The request can exceed this value because Cribl Stream adds bytes when it writes the body.
Buffer memory limit (KB): Enter the memory used to buffer outgoing requests that are waiting to be sent. Leave this blank to use 5 times the Body size limit. Enter 0 to enforce no limit.
Events-per-request limit: Enter the maximum number of events to include in the request body. Defaults to 0, which sets no limit.
Max connection reuse (seconds): Enter how long, in seconds, to reuse a keep-alive connection after its first use before closing it. Defaults to 120. Enter 0 to reuse the connection for as long as FortiSIEM allows.
Flush period (sec): Enter the maximum time between requests, in seconds. Defaults to 1. A low value can make the payload smaller than Body size limit.
Extra HTTP headers: Select Add Header to add a name-value pair sent on every request. Values are stored encrypted. You can also add headers to individual events with Dynamic headers field. See Internal Fields. Cribl Stream ignores Authorization, Content-Type, Content-Length, Transfer-Encoding, and Content-Encoding in this list.
Failed request logging mode: Select what Cribl Stream logs when a request fails: None (the default), Payload, or Payload + Headers. Payload + Headers redacts every header except the names you enter in Safe headers.
Safe headers: Enter header names that Cribl Stream can log in plaintext when Failed request logging mode is Payload + Headers. A name you enter here, including authorization, is logged as-is. Use a tab or hard return between names.
Dynamic headers field: Event field that contains the HTTP headers to add for each event. The value is an object of name-value pairs. Events that share the same headers are sent in one request. Events with different headers are sent in separate requests. Headers from this field override Extra HTTP headers that use the same name. Defaults to __headers. Cribl Stream ignores Authorization, Content-Type, Content-Length, Transfer-Encoding, and Content-Encoding.
Event Delivery
Cribl Stream posts every request to /rawupload on the host in FortiSIEM URL, using that URL’s http or https scheme. The method is POST and the Content-Type is application/x-ndjson. The body is uncompressed NDJSON, with one event on each line.
The request URL includes these query parameters:
vendor,model,reptIp, andreptName, from the routing fields under General Settings.separator=%0A, which tells FortiSIEM 7.0 and newer to split the body into individual events.
Cribl Stream URL-encodes the routing values. A space in a value is encoded as +.
An event’s __url field doesn’t change the endpoint. Authorization and Content-Type are reserved. Cribl Stream keeps the Basic authentication header and the NDJSON content type it sets, whether those names appear in Extra HTTP headers or in the value set in Dynamic headers field. It also drops Content-Length, Transfer-Encoding, and Content-Encoding, because those headers describe a body that Cribl Stream replaces when it builds the NDJSON request.
To proxy outbound HTTP/S requests, see System Proxy Configuration.
Internal Fields
Cribl Stream uses internal fields to help forward data to this Destination:
- The value set in Dynamic headers field: JSON object of header names and values to add to the request for that event. The default field name is
__headers. Cribl Stream ignoresAuthorization,Content-Type,Content-Length,Transfer-Encoding, andContent-Encoding. __url: Doesn’t change the endpoint. Cribl Stream sends the request to/rawuploadon FortiSIEM URL.
Troubleshooting
The Destination’s configuration modal has helpful tabs for troubleshooting:
Live Data: Try capturing live data to see real-time events as they flow through the Destination. 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 delivery process, including any errors or warnings that may have occurred.
Test: Ensures that the Destination is correctly set up and reachable. Verify that sample events are sent correctly by clicking Run Test.
You can also view the Monitoring page that provides a comprehensive overview of data volume and rate, helping you identify delivery issues. Analyze the graphs showing events and bytes in/out over time.
FortiSIEM URL must be a valid http(s) URL
The Destination reports FortiSIEM URL must be a valid http(s) URL when FortiSIEM URL is missing or doesn’t start with http:// or https://. Enter the FortiSIEM node base URL, and then select Save and Commit & Deploy.
Reporting Vendor is required
The Destination reports Reporting Vendor is required when Reporting Vendor is empty. Enter the vendor of the product that generated the logs.
Reporting Model is required
The Destination reports Reporting Model is required when Reporting Model is empty. Enter the model of the product that generated the logs.
Reporting Device Name is required
The Destination reports Reporting Device Name is required when Reporting Device Name is empty. Enter the reporting device hostname.
Reporting IP is required
The Destination reports Reporting IP is required when Reporting IP is empty. Enter the reporting device IP address.
Reporting IP must be a valid IP address
The Destination reports Reporting IP must be a valid IP address followed by the value you entered when Reporting IP isn’t a valid IPv4 or IPv6 address. Enter an IP address, not a hostname.
FortiSIEM requires Basic authentication via a credentials secret
The Destination reports FortiSIEM requires Basic authentication via a credentials secret when Authentication type isn’t Basic (credentials secret). Select Basic (credentials secret) and a credentials secret.
FortiSIEM username is required for Basic authentication
The Destination reports FortiSIEM username is required for Basic authentication when the credentials secret doesn’t include a username. Select a credentials secret that stores both the username and the password.
FortiSIEM password is required for Basic authentication
The Destination reports FortiSIEM password is required for Basic authentication when the credentials secret doesn’t include a password. Select a credentials secret that stores both the username and the password.