On This Page

Home / Cribl Detect/ Prepare Data (Preview)/ Enrichment (Preview)/Add an Enrichment Provider

Add an Enrichment Provider ​

Preview Feature ​

Cribl is still developing this Preview feature. 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.

Access requires App Platform, the Cribl Detect feature, and a Role that grants Apps.Read access to the Cribl Detect app.

Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the feature remains in Preview.

An enrichment provider supplies lookup data that Cribl Detect uses to add context to events before detections evaluate them. Detections can then use both the event data and its enriched context to identify matches. Add a provider from Enrichment > Providers, then choose the provider type.

Available providers include CSV and Okta.

Create an Enrichment Provider ​

In Cribl Detect, select Enrichment > Providers > Add Provider.

New providers are enabled when you save. Toggle Enabled off in the Providers list to disable one later without deleting it.

Deleting a provider also deletes the enrichment rules that join to it.

CSV ​

Use a CSV provider when your enrichment data is a comma-separated lookup file. Cribl Detect matches event fields to columns in that file and adds the matching context.

  1. For Name, enter a name that identifies the provider.
  2. For Provider type, select CSV.
  3. For CSV file, select or drag a file to upload. Cribl Detect stores it as a Cribl Stream lookup on save, then syncs from that lookup on the schedule you set.
  4. For CSV type, select Identity or Asset. These options determine which entity the CSV file describes. They don’t change the format of the CSV.
    • Identity represents a person or account.
    • Asset represents a machine or other inventory object.
    AttributeIdentityAsset
    DefinitionA user, account, or other human/IAM entityA host, device, or other inventory object
    Default join key columnsemail, username, upnhostname, ip, asset_id
    CIDR matchingNot available. Match is always exact.Available. Turn on Use for CIDR matching only when Asset is selected.
  5. Optionally, choose the Join key columns: the CSV columns that Cribl Detect indexes and matches event values against. If you don’t choose any, Cribl Detect uses the default columns for the CSV type, or the first column when none of the defaults exist.
  6. For Cron schedule, set how often to sync this provider. The default is every six hours, and you can’t sync more often than once an hour.
  7. Select Save.

If a lookup for that file name already exists, Cribl Detect asks you to replace it before saving.

Okta ​

Use an Okta provider when you want identity context from Okta, such as user or group attributes, joined to events. Cribl Detect pulls user records from Okta and flattens the profile attributes for each user into lookup columns.

  1. For Name, enter a name that identifies the provider.
  2. For Provider type, select Okta.
  3. For Okta Domain, enter your Okta subdomain. For example, enter acme for acme.okta.com.
  4. For Secret ID, enter the identifier that Cribl Detect stores the API token under.
  5. For API Token, enter an Okta API token. Cribl Detect encrypts the token at rest. To keep the existing token when you edit the provider later, leave this field empty.
  6. For Entity type, select Identity or Asset. Okta returns user records, so most users select Identity.
  7. For Cron schedule, set how often to sync this provider. The default is every six hours, and you can’t sync more often than once an hour.
  8. Select Save.

This provider reads user profiles to enrich events. To ingest Okta system logs as events, use the Cribl Stream Okta Source instead.

Refresh Provider Data ​

Cribl Detect refreshes the lookup rows on the cron schedule for a provider and once right after you create or edit the provider. To refresh on demand:

  • To refresh one provider, open the row’s Actions menu and select Sync now.
  • To refresh every provider, select Sync all on the Providers toolbar.

While a refresh runs, Last Sync shows Sync in progress. This includes refreshes that the schedule or another user started. The list updates about every 20 seconds.

Next Steps ​