Schema Monitoring (Preview)
Preview Feature
Cribl is still developing Schema Monitoring. We don’t recommend using it in a production environment, because the feature might not be fully tested or optimized for performance, and related documentation could be incomplete.
Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the feature remains in Preview.
Schema Monitoring checks live data against the schemas you choose. Use it to see when events no longer match a schema in the schema library or a Parquet schema, without checking every event on the way out.
Monitoring is off until you toggle Enable on for a Destination.
Schema Monitoring samples your events before they reach the Destination and validates those samples against the target schemas you choose. Cribl temporarily stores the sampled event content, which may contain customer data.
How Schema Monitoring Works
For each Destination where you toggle Enable on, each Worker Process keeps 1 of every 20,000 events. When events arrive more slowly than that, Schema Monitoring still takes a sample at least every 5 minutes. Events that are not sampled continue to the Destination.
Every 10 minutes, Schema Monitoring checks those samples. An event passes when it matches any target schema. Schema Monitoring reports it when it matches none of them. A sample can wait until the next check before it appears as drift.
Samples are temporary and are not quarantined.
The check skips these top-level fields:
- Every field whose name starts with
__. cribl_pipe,cribl_route,cribl_breaker,cribl_host,cribl_wp,cribl_group,cribl_mode,cribl_input, andcribl_output.
It checks _time, _raw, any other cribl_* field, and any field nested inside another field. A schema that sets additionalProperties to false reports _time or _raw as drift, with a message such as _time: should NOT have additional properties. Remove _time and _raw in the Pipeline before the Destination, or allow those fields in the schema.
Schema Monitoring checks a field’s type and the first 512 characters of each string value. The sample shows that shortened value.
- A
maxLengthabove 512 is never reported. - A
minLengthabove 512, apatternanchored at the end of the value, andformat,enum, andconstchecks use the shortened value. This applies to a long token, URL, or Base64 string.
Enable Monitoring
The Schema Monitoring table lists Destinations configured in the Worker Group. It omits the built-in default Destination and the DevNull Destination.
- In the sidebar, select Schema Monitoring.
- Select the Worker Group.
- Toggle Enable on for the Destination. When the Destination has no target schema, the Select target schema modal opens.
- Select Schema or Parquet.
- Toggle Target on for each schema to check. You can target more than one schema.
- Select Save.
The Target Schema column lists the schemas. Select Commit & Deploy. The confirmation says “Commit and deploy to change schema monitoring.” Commit and deploy the Worker Group so Workers start sampling.
Create a Destination in the Worker Group before you toggle Enable on. When the Destination already has target schemas, toggling Enable on saves those schemas and skips the modal. Select the row to change the schemas. Toggle Enable off to stop monitoring. The schemas remain assigned to the Destination. Toggle every Target off and select Save to remove the schemas and stop monitoring.
Select the Destination name to open its configuration.
To create a schema in the modal, select Add Schema. The form has the same fields as the schema library or Parquet Schemas. Toggle Target on for the new schema, then select Save. Add Schema is shown when you have permission to create that schema in the Worker Group.
When the schema list fails to load, you cannot toggle Enable on, and Target Schema shows Failed to load schemas.
Review Detections
When a check finds drift, Status shows Schema Drift Detected. Select that status to open detections for the Destination.
The table lists each detection, the target schema, and the last time that detection was seen.
Filter the detections by schema, date, or the text in Detected Drift.
Select a row. The right pane shows the Violation and the Sample Data in the event viewer. The drifted field is highlighted. The Sample Data shows when the sample was captured. It omits internal fields. System fields that the check skips can still appear there.
A sample event shows the first violation only. Other violations in that same event are not shown.
In the Actions menu, select Dismiss to hide that detection for seven days, even when the same detection returns. Monitoring continues. When every detection is dismissed, Status no longer shows Schema Drift Detected.
Who Can Change Monitoring
Members who can view the Worker Group can open Schema Monitoring. Toggling Enable on or off, or changing target schemas, requires permission to update that Destination. See Worker Group and Edge Fleet Permissions.