These docs are for Cribl Edge 4.11 and are no longer actively maintained.
See the latest version (4.13).
Output Router Destination
Output Routers are meta-destinations that allow for output selection based on rules. Rules are evaluated in order, top‑down, with the first match being the winner.
Type: Internal | TLS Support: N/A | PQ Support: N/A
Configure Cribl Edge to Send to an Output Router
In Cribl Edge, configure Output Router:
- On the top bar, select Products, and then select Cribl Edge. Under Fleets, select a Fleet. Next, you have two options:
- To configure via QuickConnect, navigate to Routing > QuickConnect (Stream) or Collect (Edge). Select Add Destination and select the Destination you want from the list, choosing either Select Existing or Add New.
- To configure via the Routes, select Data > Destinations or More > Destinations (Edge). Select the Destination you want. Next, select Add Destination.
- In the New Destination modal, configure the following under General Settings:
- Router name: Enter a unique name to identify this Router definition. If you clone this Destination, Cribl Edge will add
-CLONE
to the original Output ID. - Description: Optionally, enter a description.
- Rules: A list of event routing rules. For details, see Rules below.
- Router name: Enter a unique name to identify this Router definition. If you clone this Destination, Cribl Edge will add
- Next, you can configure the following Optional Settings:
- System fields: A list of fields to automatically add to events that use this output. For details, see System Fields below.
- Tags: Optionally, add tags that you can use to filter and group Destinations on the Destinations page. These tags aren’t added to processed events. Use a tab or hard return between (arbitrary) tag names.
- Optionally, configure any Advanced settings outlined in the sections below.
- Select Save, then Commit & Deploy.
Rules
Configure the following event routing rules settings.
- Filter expression: JavaScript expression to select events to send to output.
- Output: Output to send matching events to.
- Description: Optionally, enter a description of this rule’s purpose.
- Final: Toggle off if you want the event to be checked against other rules lower in the stack.
System Fields
By default, includes cribl_pipe
(identifying the Cribl Edge Pipeline that processed the event). Supports wildcards. Other options include:
cribl_host
– Cribl Edge Node that processed the event.cribl_input
– Cribl Edge Source that processed the event.cribl_output
– Cribl Edge Destination that processed the event.cribl_route
– Cribl Edge Route (or QuickConnect) that processed the event.cribl_wp
– Cribl Edge Worker Process that processed the event.
Advanced Settings
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 config will be enabled everywhere.
Limitations/Options
- An Output Router cannot reference another. This is by design, to avoid circular references.
- Also to avoid circular references, an Output Router cannot reference a Default Destination that points back to Output Router.
- Events that do not match any of the rules are dropped. Use a catch-all rule to change this behavior.
- No post-processing (conditioning) can be attached to the Output Router Destination itself. But you are free to use pre‑processing Pipelines on the Source tier, and post-processing Pipelines on any or all Destinations that the Output Router references.
- Data can be cloned by toggling Final off. Toggling on (default) results in no cloning.
Example
Scenario:
- Send all events where
host
starts with66
to DestinationSan Francisco
. - From the rest of the events: Send all events with
method
fieldPOST
orGET
to bothSeattle
andLos Angeles
(i.e., clone them). - Send the remaining events to
New York City
.
Router Name: router66
Filter Expression | Output | Final |
---|---|---|
host.startsWith('66') | San Francisco | Yes |
method=='POST' || method=='GET | Seattle | No |
method=='POST' || method=='GET' | Los Angeles | Yes |
true | New York | Yes |