Coralogix CLI

Coralogix is on a mission to provide a CLI that will enable you to do all your Coralogix operations without the web interface involved. Currently, we support:

1. Quota management to help you manage quota across your teams.

2. SAML management allows the management of SAML SSO configuration by admin users.

3. Team management allows admins to create teams and invite users.

4. LiveTail (a live log stream from all your services). You can filter your logs by Coralogix metadata fields such as application name, subsystem name, and severity and also by querying the data itself. Live tail is much like how the stern command in K8s streams logs in real-time. 

Install the Coralogix CLI for MacOS/Linux

Requirements

To use this API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add individual permissions.

Preset	Action	Description
DataQuerying	LEGACY-ARCHIVE-QUERIES:EXECUTE LOGS.DATA-API#HIGH:READDATA LOGS.DATA-API#LOW:READDATA METRICS.DATA-API#HIGH:READDATA SPANS.DATA-API#HIGH:READDATA SPANS.DATA-API#LOW:READDATA	Query Data from the Archive Query Frequent Search Logs Query Monitoring & Compliance Logs Query Metrics Query Frequent Search Spans Query Monitoring & Compliance Spans
LiveTail	LIVETAIL:READ	View LiveTail Data

Download

curl -O https://coralogix-public.s3-eu-west-1.amazonaws.com/cxctl/latest/cxctl-macOS.gz

Or

curl -O https://coralogix-public.s3-eu-west-1.amazonaws.com/cxctl/latest/cxctl-Linux.gz

Unzip

gunzip -N cxctl-*.gz

Make executable

chmod +x cxctl

Set environment variables:

export CORALOGIX_API_KEY=<cx_api_key>

Scan option

Scan examples

Histogram

Prints a time-based log count histogram.

S3 bucket	\--bucket <bucket name>, -b <bucket name>
Time range - Start	--range-start <start time>, -s <start time>
Time range - End	--range-end <end time>, -e <end time>
Application	--application <app1,app2>
Subsystem	--subsystem <sub1,sub2>
Severity	--severity <severity>
Limit the number of logs	-c <number>
Query	" <your_query> "

Log streaming

In order to stream the logs in real-time (as they are being archived) use the following command:

./cxctl livetail --region "region-name" --api-key <cx_api_key> --format pretty --application "app-name" --subsystem "subsystem-name"

A Coralogix API key can be passed to the scanner through the `--api-key` argument or as an environment variable

Streaming supports the following regions:

Region	US1	US2	EU1	EU1	AP1	AP2
region-name	us1	us2	eu	se	in	sg

By default, the logs use the `pretty` format. A `raw` format is also available which prints out the logs as JSON objects

The scanner will tail the logs infinitely by default but can stop after a specified number of log lines using --count

LiveTail option

Previous Hosted Grafana API

Next Team Management (via CLI)

Theme

Light

light

dark