Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johnmccabe/podtail

#golang port of kubetail to tail Kubernetes logs from multiple pods at the same time, works on windows, osx and linux
https://github.com/johnmccabe/podtail

golang kubernetes kubetail linux logging logs osx pods windows

Last synced: 1 day ago
JSON representation

#golang port of kubetail to tail Kubernetes logs from multiple pods at the same time, works on windows, osx and linux

Host: GitHub
URL: https://github.com/johnmccabe/podtail
Owner: johnmccabe
License: apache-2.0
Created: 2017-10-10T22:20:53.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-02-01T01:57:19.000Z (almost 7 years ago)
Last Synced: 2024-06-20T01:57:07.251Z (7 months ago)
Topics: golang, kubernetes, kubetail, linux, logging, logs, osx, pods, windows
Language: Go
Size: 697 KB
Stars: 6
Watchers: 3
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Podtail

[![Build Status](https://travis-ci.org/johnmccabe/podtail.svg "Travis CI status")](https://travis-ci.org/johnmccabe/podtail)

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

[![GitHub (pre-)release](https://img.shields.io/github/release/johnmccabe/podtail/all.svg)](https://github.com/johnmccabe/podtail/releases)

Podtail is a Go port of Johan Haleby's [kubetail](https://github.com/johanhaleby/kubetail) utilty which now also allows Windows users to aggregate (tail/follow) logs from multiple pods into one stream.

This is the same as running `kubectl logs -f ` but for multiple pods.

## Compatibility with kubetail

The following checklist details which flags/options are currently supported:

- [x] `-h, --help`

- [ ] `-c, --container`

- [x] `-t, --context`

- [x] `-l, --selector`

- [x] `-n, --namespace`

- [x] `-s, --since`

- [ ] `-b, --line-buffered`

- [x] `-e, --regex`

- [ ] `-j, --jq`

- [x] `-k, --colored-output`

- [ ] `-z, --skip-colors`

- [x] `--timestamps`

- [x] `--tail`

- [x] `-v, --version`

Please raise an issue if theres an unimplemented flag you need support for.

## Installation

Podtail currently wraps the `kubectl` command which you need to have installed in order to use `podtail`.

Please refer to the Kubernetes documentation for information on how to install `kubectl` for your specific OS.

### OSX

You use Brew to install the client as follows:

    $ brew tap johnmccabe/podtail && brew install podtail

### Windows

Just download `podtail.exe` from the [Github Releases](https://github.com/johnmccabe/podtail/releases/) page and copy it to a location on your `%PATH%`.

### Linux

Just download `podtail.tgz` from the [Github Releases](https://github.com/johnmccabe/podtail/releases/) page, extract and copy it to a location on your `$PATH`.

## Usage

Details of the support flags etc can be seen using the `--help` flag.

    podtail --help

Note that if `kubectl` isn't on the path you can explicitly point to it with the `--kubectl` flag, also if your Kube cluster config isn't in the standard `~/.kube/config` location you can point to an explicit location with the `--kubeconfig` flag.

Some example commands include:

    podtail my-pod-v1

    podtail my-pod-v1 -t int1-context

    podtail '(service|consumer|thing)' -e regex

    podtail -l service=my-service

    podtail --selector service=my-service --since 10m

    podtail --tail 1

    podtail gateway --kubectl C:/Kubernetes/bin/kubectl --kubeconf ./myconfig