On This Page

Home / Stream/ Reference/ CLI Reference/diag

diag

Manages diagnostic bundles. For failover mode, see how to prevent and troubleshoot CLI problems.

Sub-commands:

Sub-commands and Options
​

diag create
​

Create a diagnostic bundle for this instance.

Usage:

./cribl diag create

Arguments:

OptionDefinition
-dRun create in debug mode.
-jDo not append ‘.txt’ to js files.
-kInclude metrics for the top 10 Sources, Destinations, Pipelines, Routes, and Packs from the last 24 hours. This matches the Include top talkers option in the UI and is separate from the main metrics store controlled by -M.
-t <maxIncludeJobs>Maximum number of jobs (and all associated tasks) to include in the bundle.
-MExclude the persistent internal metrics store from the bundle. This reduces bundle size, especially on Leaders and single-instance deployments, but does not remove other metric-related data (such as logs or data added with -k).
-gExclude git from bundle.
-iInclude install logs.

Windows PowerShell usage:

PS > $env:CRIBL_VOLUME_DIR='c:\ProgramData\Cribl'; & 'c:\Program Files\Cribl\bin\cribl.exe' diag create

The Windows command requires the CRIBL_VOLUME_DIR environment variable. If your deployment doesn’t use the default path (c:\ProgramData\Cribl), verify that CRIBL_VOLUME_DIR points to the correct directory. Otherwise, you might get empty diag files.

Sample response:

Created diagnostic bundle at c:\ProgramData\Cribl\diag\edge-DESKTOP-C9BEMQ2-20240925T222216.tar.gz

Windows CMD usage:

> set "CRIBL_VOLUME_DIR=c:\ProgramData\Cribl" && "c:\Program Files\Cribl\bin\cribl.exe" diag create

Sample response:

Created diagnostic bundle at c:\ProgramData\Cribl\diag\edge-DESKTOP-C9BEMQ2-20240925T222216.tar.gz

diag cpuprofile
​

Collect a 30-second CPU profile and place in the diag directory.

Usage:

./cribl diag cpuprofile -p 12345

Sample response:

Created a Cribl diagnostic bundle at /opt/cribl/diag/<product>-zedborcdb72f-20210820T204405.tar.gz

Arguments:

OptionDefinition
-p <pid>The pid of the process to dump the CPU profile.

diag heapsnapshot
​

Generate heap snapshot of a Cribl process and place in the diag directory.

Usage:

./cribl diag heapsnapshot -p 12345

Sample response:

Heap-1672574400000-12345.heapsnapshot

The response format is Heap-<epoch-timestamp>-<pid>.heapsnapshot.

Arguments:

OptionDefinition
-p <pid>The pid of the process to dump the heap snapshot.

diag list
​

List existing diagnostic bundles.

diag perf
​

Collect a 30-second CPU profile and a heapsnapshot and place both in the diag directory.

OptionDefinition
-p <pid>The pid of the process to dump both the CPU profile and heap snapshot.

diag send
​

Send diagnostics bundle to Cribl Support.

./cribl diag send -c 00001234

Arguments:

OptionDefinition
-c <caseNumber>Cribl Support Case Number.
-p <path>Diagnostic bundle path. If empty, it creates a new bundle.