https://github.com/ivoronin/clibana

Clibana - A CLI tool for OpenSearch, providing Kibana-like log search and live tailing with -f support
https://github.com/ivoronin/clibana

Last synced: 5 days ago
JSON representation

Clibana - A CLI tool for OpenSearch, providing Kibana-like log search and live tailing with -f support

• Host: GitHub
• URL: https://github.com/ivoronin/clibana
• Owner: ivoronin
• Created: 2024-08-05T21:01:18.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-18T13:55:15.000Z (3 months ago)
• Last Synced: 2024-08-18T15:03:47.082Z (3 months ago)
• Language: Go
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Clibana

![GitHub release (with filter)](https://img.shields.io/github/v/release/ivoronin/clibana)

[![Go Report Card](https://goreportcard.com/badge/github.com/ivoronin/clibana)](https://goreportcard.com/report/github.com/ivoronin/clibana)

![GitHub last commit (branch)](https://img.shields.io/github/last-commit/ivoronin/clibana/main)

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ivoronin/clibana/main.yml)

![GitHub top language](https://img.shields.io/github/languages/top/ivoronin/clibana)

## 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

```bash

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`.