Cribl Stream
@figura/cribl-streamv2026.07.20.1784548020
01README
CRIBL Stream Cloud — read-only integration for troubleshooting sources, routes, pipelines, destinations, event capture, lookups, and knowledge objects via the CRIBL Cloud REST API. Authentication uses OAuth2 client_credentials grant. All methods are read-only observation/sync operations scoped to a worker group.
Authentication
Requires a CRIBL Cloud API Client ID and Client Secret, stored in a swamp vault. Generate credentials in CRIBL Cloud under Settings → API Credentials.
Methods
- list_sources — List all input sources in a worker group - get_source — Get detailed config for a specific source - list_routes — List routes with filter, pipeline, output mappings - list_pipelines — List all pipelines in a worker group - get_pipeline — Get pipeline config with all functions - list_destinations — List output destinations with status - get_destination — Get detailed config for a destination - capture_events — Capture/preview live events at a pipeline point - list_lookups — List lookup files in a worker group - list_knowledge — List knowledge objects (parsers, vars, schemas) - health — Fan-out health check across all components
02Release Notes
patch: minor metadata refresh
03Models
@figura/cribl-streamv2026.07.17.2cribl_stream.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| clientId | string | CRIBL API Client ID |
fn list_sources(workerGroup: string)
List all input sources in a worker group with their type and enabled/disabled status.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name (e.g. default, acceptance) |
fn get_source(workerGroup: string, sourceId: string)
Get detailed configuration for a specific source by ID.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
| sourceId | string | Source ID |
fn list_routes(workerGroup: string)
List all routes in a worker group with their filter, pipeline, output, and enabled/disabled state.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
fn list_pipelines(workerGroup: string)
List all pipelines in a worker group.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
fn get_pipeline(workerGroup: string, pipelineId: string)
Get detailed configuration for a specific pipeline, including all functions.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
| pipelineId | string | Pipeline ID |
fn list_destinations(workerGroup: string)
List all output destinations in a worker group with their type and status.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
fn get_destination(workerGroup: string, destinationId: string)
Get detailed configuration for a specific destination by ID.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
| destinationId | string | Destination ID |
fn capture_events(workerGroup: string, sourceId?: string, pipelineId?: string, filter?: string, maxEvents: number)
Capture/preview live events at a specific point in the pipeline.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
| sourceId? | string | Source ID to capture from (optional if pipelineId given) |
| pipelineId? | string | Pipeline ID to capture from (optional if sourceId given) |
| filter? | string | Optional filter expression to narrow captured events |
| maxEvents | number | Maximum number of events to capture (default: 10) |
fn list_lookups(workerGroup: string)
List all lookup files available in a worker group.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
fn list_knowledge(workerGroup: string)
List knowledge objects (parsers, global variables, schemas) in a worker group.
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
fn health(workerGroup: string)
Fan-out health check: scans all sources, routes, pipelines, and destinations
| Argument | Type | Description |
|---|---|---|
| workerGroup | string | Worker group name |
Resources
sources(15m)— Input sources configured in a worker group
source_detail(15m)— Detailed config for a specific source
routes(15m)— Routes configured in a worker group
pipelines(15m)— Pipelines configured in a worker group
pipeline_detail(15m)— Detailed config for a specific pipeline with functions
destinations(15m)— Output destinations configured in a worker group
destination_detail(15m)— Detailed config for a specific destination
capture(30m)— Captured events from a pipeline point
lookups(15m)— Lookup files in a worker group
knowledge(15m)— Knowledge objects (parsers, schemas, global variables)
health(5m)— Aggregated health overview of a worker group
04Previous Versions
2026.07.17.3Jul 17, 2026
2026.07.17.2Jul 17, 2026
2026.07.17.1Jul 17, 2026
2026.07.07.2Jul 7, 2026
2026.07.07.1Jul 7, 2026
05Stats
A
100 / 100
Downloads
1
Archive size
14.4 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels