logiqctl
¶
logiqctl is LOGIQ's inbuilt command-line toolkit that lets you interact with the LOGIQ Observability platform without logging into the UI. Using logiqctl, you can:
- Stream logs in real-time
- Query historical application logs
- Search within logs across namespaces
- Query and view events across your LOGIQ stack
- View and create event rules
- Create and manage dashboards
- Query and view all your resources on LOGIQ such as applications, dashboards, namespaces, processes, and queries
- Extract and report log pattern signatures (up to a maximum of 50,000 log-lines)
- Manage LOGIQ licenses
Quickstart¶
The quickest way to start using logiqctl
is to download a pre-built binary from our release page on GitHub.
Configuring logiqctl
¶
Once you've downloaded the binary, you can configure logiqctl
to interact with your LOGIQ instance by doing the following:
- Set your cluster URL:
logiqctl config set-cluster CLUSTER_URL
- Set your LOGIQ credentials:
logiqctl config set-ui-credential flash-userid password
- Set your default namespace:
logiqctl config set-context NAMESPACE
- Verify your
logiqctl
configuration:logiqctl get namespaces
This completes the installation of logiqctl
. You can now use logiqctl
to interact with your LOGIQ instance right from your terminal.
Building logiqctl
from source¶
Another way of installing logiqctl
is by building it from the source code. Building logiqctl
from its source code involves two steps:
- Installing dependencies
- Downloading and building the logiqctl
binary
Installing dependencies¶
logiqctl
has the following dependencies:
- Go: You can install Go by following the instructions listed on [https://golang.org/dl/]
- Protocol Buffers: Download the binary and set it up by running the following commands:
On macOS:
PROTOC_ZIP=protoc-3.15.6-osx-x86_64.zip
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.15.6/$PROTOC_ZIP
sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
rm -f $PROTOC_ZIP
On Linux OS:
PROTOC_ZIP=protoc-3.15.6-linux-x86_64.zip
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.15.6/$PROTOC_ZIP
sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
rm -f $PROTOC_ZIP
This completes the installation of all logiqctl
dependencies.
Building logiqctl
¶
Run the following commands to build logiqctl
from the source code:
- Create a directory inside your workspace in which to keep source code:
mkdir -p $GOPATH/src/github.com/logiqai
- Accesss the source code directory:
cd $GOPATH/src/github.com/logiqai
- Clone the
logiqctl
GitHub repository into this folder:git clone git@github.com:logiqai/logiqctl.git
- Access the repository you just cloned:
cd logiqctl
- Build
logiqctl
:go build logiqctl.go
- Make the binary
logiqctl
executable:chmod +x ./logiqctl
- Verify the build:
logiqctl -h
logiqctl
is now built and ready for configuration and use. To configure logiqctl
, refer to the configuration instructions listed under Configuring logiqctl
.
Available logiqctl
commands¶
Command | Operation |
---|---|
logiqctl config |
Configure logiqctl or modify existing logiqctl configuration |
logiqctl create |
Create LOGIQ resources such as dashboards and event rules |
logiqctl get |
Display one or more LOGIQ resources |
logiqctl license |
View and manage your LOGIQ license |
logiqctl logs |
View logs for the given namespace and application |
logiqctl tail |
Stream logs from your LOGIQ instance in real-time |
Options¶
-c, --cluster string Override the default cluster set by `logiqctl set-cluster' command
-h, --help help for logiqctl
-n, --namespace string Override the default context set by `logiqctl set-context' command
-o, --output string Output format. One of: table|json|yaml.
json output is not indented, use '| jq' for advanced json operations (default "table")
-t, --time-format string Time formatting options. One of: relative|epoch|RFC3339.
This is only applicable when the output format is table. json and yaml outputs will have time in epoch seconds. (default "relative")
To know more about the LOGIQ Observability stack, see https://logiq.ai/ and https://docs.logiq.ai/.
In case of issues or questions, do reach out to us at [cli@logiq.ai]. You can also log an issue in our logiqctl
source code repository on GitHub.