For the complete documentation index, see llms.txt.

Home
Cribl Stream Cribl Edge Cribl Search Cribl Lake Cribl Insights
Known Issues Release Notes What's New Cribl Copilot
SandboxGitHub Repos Docker Hub Cribl as Code
(Ctrl+K / Cmd+K)
No Results Try to type a different keyword or phrase
What are you looking for? Type a keyword or phrase above
All Results Press Enter
API Reference Cribl Status Cribl.Cloud
Stream
4.20
Release Notes4.204.194.184.174.164.154.144.134.124.114.104.94.84.74.64.54.44.34.24.14.0
Cribl Stream
4.20
4.204.194.184.174.164.154.144.134.124.114.104.94.84.74.64.54.44.34.24.14.0
Get Started
Cribl Stream Basic ConceptsLog in to CriblQuickConnect
Tutorials
Cribl Stream TourGet Started with Cribl StreamDistributed Quick Start
Onboard Faster With Packs
Get Pre-Built Pack ContentUse Packs to Get Started With REST Collection
Process Data with AI Assistance
Create Pipelines With Cribl Copilot EditorConvert Data into a Custom Schema
Set Up Cribl Stream
Reference ArchitecturesCribl.Cloud vs. Self-Hosted
About Connected Environments
How to Connect On-Prem Leaders to Cribl.CloudSimplify Billing with Universal SubscriptionData Payloads for Connected EnvironmentsSend Data from On-Prem to Cribl.Cloud
Deployment Planning
Sizing and ScalingOS Tuning for Large DeploymentsArchitectural ConsiderationsPorts
Cribl.Cloud
Register Cribl.Cloud OrganizationManage Cribl.Cloud OrganizationCribl.Cloud EnterpriseManage Cribl.Cloud Worker GroupsPrivate Link for Cribl.Cloud
About Connected Environments
How to Connect On-Prem Leaders to Cribl.CloudSimplify Billing with Universal SubscriptionData Payloads for Connected Environments
On-Prem Deployment
OS and System RequirementsSingle-Instance/​Basic DeploymentRun Cribl StreamConfigure Cribl Stream for Non-Root User
Distributed Deployment
Set Up Leader and Worker NodesManage Worker GroupsManage WorkersMap Workers to Worker GroupsManage Config BundlesConfigurations and RestartDeploy Stream ConfigurationsPersistent Socket Connections
Splunk App DeploymentBootstrap Workers from Leader
Leader High Availability/Failover
High Availability RequirementsConfigure Standby Leader NodesManage High Availability Deployment
Converting a Single Instance to Distributed Deployment
Orchestrated Deployment
Kubernetes/Helm DeploymentKubernetes Worker DeploymentConsiderations for Cribl Stream on Kubernetes
Connect Through Cribl Outpost
Set Up Cribl OutpostManage Cribl OutpostConfigure Outpost Group Settings
Set Up Version ControlDocker Deployment
Administration
FinOps CenterLicensing
Configuration Management
Commit and Deploy Changes
Remote Repositories
Handle Customer-Defined .gitignore Exclusions
Configure Worker Group SettingsGitOps
Workspaces
Configure WorkspacesEnable Static Egress IPs for Cribl.Cloud
Projects
Configure ProjectsConfigure SubscriptionsAdd Users to Projects
Notifications
Email Notifications
Notification Targets
Webhook Notification TargetsPagerDuty Notification TargetsSlack Notification TargetsAWS SNS Notification TargetsEmail Notification Targets
Customize the Interface
Custom BannersCustom Login Page
Scripts
Upgrade
Upgrade Outpost
Uninstall Cribl Stream
Access Management
Secure Your Deployment
Cribl GuardSecure Your Cribl.Cloud DeploymentSecure Your On-Prem/Hybrid DeploymentSecure Node AccessCreate and Manage Authentication Tokens
Configure TLS
Add TLS Certificates and KeysSecure Leader-Worker Communication with TLSSecure Leader-Node Communication with mTLS (On-Prem)Secure Sources and Destinations with TLS and mTLSConfigure TLS for API and UI AccessTLS Defaults and System-wide Settings
Custom HTTP HeadersConfigure System ProxyConfigure SOCKS Proxy
Centralize and Reuse Global Secrets
Add, Use, and Deploy Global SecretsRotate Global SecretsBack Up, Audit, and Troubleshoot Global Secrets
Connect External Secret Stores
Connect Azure Key Vault Secret StoresConnect HashiCorp Vault Secret Stores
Create and Manage Legacy Secrets in Cribl StreamConfigure KMS ProvidersCreate and Manage Encryption Keys
Compliance
FIPS Mode for Cribl StreamRunning Cribl Stream on a Hardened OSSELinux (Enforcing Mode) Configuration
Monitor Health and Metrics
Internal Metrics
Internal Logs
cribl.logaccess.logaudit.logmetrics.lognotifications.logui-access.log
Work with Data
Ingest and Inspect Data
Onboard DataUse Datagens to Simulate Live DataCreate and Share Data Samples
Data Sample Use Cases
Ingest-Time SamplingSample LogsAccess Logs: Apache, ELB, CDN, S3Firewall Logs: VPC Flow Logs, Cisco ASA
Event Data Structure and Flow
Event ModelEvent Processing OrderEvent Breakers
Event Breaker Types
Azure Virtual Network (VNet) Flow Event BreakerCSV Event BreakerFile Header Event BreakerJSON Array Event BreakerJSON New Line Delimited Event BreakerRegex Event BreakerTimestamp Event Breaker
Routes
Pipelines
Validate Pipeline Logic Using Data Preview
Manage Metrics and High Cardinality
Enrich Data Using Lookups
About LookupsConfigure LookupsLookup Geographic Data from IP AddressesLookups as Filters for MasksLookups and Regex Magic
Transform Data
Build Custom Logic to Route and Process Your DataIngest-Time FieldsMasking and ObfuscationEncryption of Data in MotionReducing Windows XML EventsRegex Filtering
Functions
AggregationsAggregate MetricsAuto TimestampCEF SerializerChainCloneCodeCommentDNS LookupDropDrop DimensionsDynamic SamplingEvalEvent Breaker FunctionFlattenFold KeysGeoIPGrokGuardJSON UnrollLookupMaskNumerifyOTLP LogsOTLP MetricsOTLP TracesParserPublish MetricsRedisRegex ExtractRegex FilterRenameRollup MetricsSamplingSerializeSNMP Trap SerializeSuppressUnrollXML UnrollPrometheus Publisher (deprecated)Reverse DNS (deprecated)Tee (deprecated)Trim Timestamp (deprecated)
Integrations
Sources
Collector Sources
Azure Blob StorageCribl LakeDatabaseFile System/NFSGoogle Cloud StorageHealth CheckREST / API EndpointS3ScriptSplunk SearchManage Collector State in Database and REST API CollectorsSchedule and Run Collector JobsHigh-Availability CollectorsJob Limits
Using Collectors
Configure a Database ConnectionUsing S3 Storage and ReplayUsing REST/API CollectorsGenerate HMAC Functions for REST Collector RequestsLacework API CollectionMicrosoft Graph API CollectionServiceNow API CollectionCreating a Custom Collector
Amazon
Amazon BedrockAmazon Data FirehoseAmazon Kinesis Data StreamsAmazon S3Amazon Security LakeAmazon SQS
Azure
Azure Blob StorageAzure VNet Flow LogsAzure Event HubsAzure Event Hubs AMQP
Google Cloud
Google Cloud Pub/Sub
Kafka
KafkaConfluent CloudAmazon MSK
Microsoft 365
Microsoft 365 ActivityMicrosoft 365 Message TraceMicrosoft 365 ServicesMicrosoft CopilotMicrosoft Graph
Prometheus
Prometheus ScraperPrometheus Remote WriteGrafanaLoki
Splunk
Splunk HECSplunk SearchSplunk TCP
Internal
Cribl InternalCribl HTTPCribl TCP
System
DatagenExecFile MonitorJournal FilesSystem MetricsSystem State
Akamai HECAppScopeAqua SecurityBeyondTrust