These docs are for Cribl Edge 4.11 and are no longer actively maintained.
See the latest version (4.13).
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 createArguments:
| Option | Definition |
|---|---|
-d | Run create in debug mode. |
-j | Do not append ‘.txt’ to js files. |
-k | Include metrics for the top 10 Sources, Destinations, Pipelines, Routes, and Packs from the last 24 hours. |
-t <maxIncludeJobs> | Latest number of jobs to include in bundle. |
-M | Exclude metrics from bundle. |
-g | Exclude git from bundle. |
-i | Include 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_DIRenvironment variable. If your deployment doesn’t use the default path (c:\ProgramData\Cribl), verify thatCRIBL_VOLUME_DIRpoints to the correct directory.
Sample response:
Created diagnostic bundle at c:\ProgramData\Cribl\diag\edge-DESKTOP-C9BEMQ2-20240925T222216.tar.gzWindows 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.gzdiag cpuprofile
Collect a 30-second CPU profile and place in the diag directory.
Usage:
./cribl diag cpuprofile -p 12345Sample response:
Created a Cribl diagnostic bundle at /opt/cribl/diag/<product>-zedborcdb72f-20210820T204405.tar.gzArguments:
| Option | Definition |
|---|---|
-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 12345Sample response:
Heap-1672574400000-12345.heapsnapshotThe response format is
Heap-<epoch-timestamp>-<pid>.heapsnapshot.
Arguments:
| Option | Definition |
|---|---|
-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.
| Option | Definition |
|---|---|
-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 00001234Arguments:
| Option | Definition |
|---|---|
-c <caseNumber> | Cribl Support Case Number. |
-p <path> | Diagnostic bundle path. If empty, it creates a new bundle. |