https://github.com/l-lin/kubetailrb
Tail your k8s pod logs at the same time.
https://github.com/l-lin/kubetailrb
Last synced: 18 days ago
JSON representation
Tail your k8s pod logs at the same time.
- Host: GitHub
- URL: https://github.com/l-lin/kubetailrb
- Owner: l-lin
- License: mit
- Created: 2024-10-29T19:44:47.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T20:34:22.000Z (5 months ago)
- Last Synced: 2024-12-17T01:55:37.427Z (5 months ago)
- Language: Ruby
- Size: 405 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Kubetailrb
[](https://github.com/HazAT/badge/blob/master/LICENSE)
[](http://rubygems.org/gems/kubetailrb)
> Tail your Kubernetes pod logs at the same time.
## Installation
```sh
gem install kubetailrb
```
If you want to install directly from the repository instead:
```sh
# Install dependencies.
./bin/setup
# Install gem onto your local machine
bundle exec rake install
```
## Usage
```bash
# show help
kubetailrb -h
# follow pod logs
kubetailrb 'clock' --namespace sandbox --raw
# follow pod structured JSON logs and display in human friendly way
kubetailrb 'clock-json' --namespace sandbox --follow
# or with shorter flags
kubetailrb 'clock-json' -n sandbox -f
# you can filter the pods using regex on the pod names
kubetailrb '^clock(?!-json)' -n sandbox -f
# you can also filter the containers using regex on the container names
kubetailrb 'clock' -n sandbox -f -c 'my-container'
# you can exclude access logs
kubetailrb 'clock' -n sandbox -f --excludes access-logs
# or Datadog logs
kubetailrb 'clock' -n sandbox -f --excludes dd-logs
# or both
kubetailrb 'clock' -n sandbox -f --excludes access-logs,dd-logs
# you can include your MDCs by adding your MDC names separated by a comma
kubetailrb 'clock' -n sandbox -f --mdcs thread.name,service.version
```
## Development
```bash
# Open interactive prompt to allow you to experiment.
./bin/console
# Check available tasks that can be run
bundle exec rake --tasks
# During your development phase, run tests automatically.
bundle exec rake test:watch
# Run tests, cucumber features and lint.
bundle exec rake
```
## Release a new version
Update the version in
[`lib/kubetailrb/version.rb`](./lib/kubetailrb/version.rb).
> [!WARNING]
> You may have to update the tests...
> Too lazy to update the script to also update the tests...
Then execute the script:
```sh
./bin/release
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/l-lin/kubetailrb.
## Note
This project is a pet project I used to learn the [Ruby programming language](https://www.ruby-lang.org/en/).
So you might find lots of my [personal notes](./journey_log.md) in the codebase.
If you want to have something that is more complete, please look at
[stern](https://github.com/stern/stern) project that was used as inspirations
instead.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).