Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.77 KB

README.md

File metadata and controls

32 lines (23 loc) · 1.77 KB
Raw

Clibana

GitHub release (with filter) Go Report Card GitHub last commit (branch) GitHub Workflow Status (with event) GitHub top language

Description

Clibana is a command-line interface (CLI) tool for OpenSearch that offers Kibana-like log searching and live tailing (-f support) capabilities.

Features

  • Log Search: Execute searches on multiple OpenSearch indices using Lucene query syntax. Clibana can output specified fields or export data in NDJSON format.
  • Live Tailing: Monitor logs in real-time using the -f option, similar to tail -f.
  • Cluster Exploration: List index information and field mappings.
  • AWS and Basic Authentication: Supports both AWS SigV4 and Basic Authentication methods.

Examples

clibana -H https://logs.internal -i "pods-*" search -s now-2h -e now-1h "pod_name:*nginx*"
clibana -H https://logs.internal -i "pods-*" mappings
clibana -H https://logs.internal -i "pods-*" indices

Most options can be set using environment variables. Check clibana -h for additional details.

AWS Support

  1. Clibana supports the aws:// scheme to specify an AWS Managed OpenSearch Domain name as a host, which will automatically resolve to its endpoint. Example: clibana --host aws://logs-internal.
  2. You can use your AWS credentials to authenticate to an AWS Managed OpenSearch Domain. Set the authentication type to aws: clibana -a aws.