https://github.com/stevenjdh/klogs
Automates the dumping of various pieces of information about a Kubernetes cluster to support troubleshooting efforts.
https://github.com/stevenjdh/klogs
automation dumps kubernetes kubernetes-cluster logs troubleshooting
Last synced: about 2 months ago
JSON representation
Automates the dumping of various pieces of information about a Kubernetes cluster to support troubleshooting efforts.
- Host: GitHub
- URL: https://github.com/stevenjdh/klogs
- Owner: StevenJDH
- License: gpl-3.0
- Created: 2019-08-23T04:55:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-29T13:54:28.000Z (over 5 years ago)
- Last Synced: 2025-03-31T08:21:11.991Z (about 1 year ago)
- Topics: automation, dumps, kubernetes, kubernetes-cluster, logs, troubleshooting
- Language: C#
- Size: 754 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# klogs (Kubernetes Logs)
klogs, pronounced "kelloggs" like the cereal, is a tool that automates the dumping of various pieces of information about a Kubernetes cluster to support troubleshooting efforts with different issues being encountered. Many objects are supported, and this tool can run on any platform supported by Kubernetes and the .Net Core Framework.
Releases: [https://github.com/StevenJDH/klogs/releases](https://github.com/StevenJDH/klogs/releases)
## Features
* Dumps YAML documents, current and previous instance logs, descriptions with events, and anything else useful for troubleshooting.
* Supports many objects such as pods, services, deployments, replicasets, statefulset, cronjobs, etc.
* Optionally dumps logs to a Zip file instead of a folder for easier sharing.
* Cross-platform support for Linux, Windows, macOS, and any other platform supporting the .NET Core Framework.
## Future features
* GUI mode once .NET Core 3.0 is released and I have time.
* Additional command line options.
* A single executable file for portable releases once .NET Core 3.0 is released.
## Prerequisites
* Non-portable klogs releases require [.NET Core 2.2+ runtime or SDK](https://dotnet.microsoft.com/download) installed.
* Linux users using portable releases, see additional [distribution dependencies](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x#linux-distribution-dependencies) if there are any issues.
## Command line usage
Below is the usage information that is needed to run the program via the command line. Some setups may also allow launching klogs directly.
[--Usage--]
Universal: dotnet klogs.dll [-a | -h]
Linux: ./klogs [-a | -h]
Windows: klogs.exe [-a | -h]
macOS: open klogs [-a | -h]
Options:
-a, -A Archives the dumped logs to a Zip file.
-?, -h, -H Displays this usage information.
## Disclaimer
klogs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
## Do you have any questions?
Many commonly asked questions are answered in the FAQ:
[https://github.com/StevenJDH/klogs/wiki/FAQ](https://github.com/StevenJDH/klogs/wiki/FAQ)
## Want to show your support?
|Method | Address |
|------------:|:-----------------------------------------------------------------------------------------------------------|
|PayPal: | [https://www.paypal.me/stevenjdh](https://www.paypal.me/stevenjdh "Steven's Paypal Page") |
|Bitcoin: | 3GyeQvN6imXEHVcdwrZwKHLZNGdnXeDfw2 |
|Litecoin: | MAJtR4ccdyUQtiiBpg9PwF2AZ6Xbk5ioLm |
|Ethereum: | 0xa62b53c1d49f9C481e20E5675fbffDab2Fcda82E |
|Dash: | Xw5bDL93fFNHe9FAGHV4hjoGfDpfwsqAAj |
|Zcash: | t1a2Kr3jFv8WksgPBcMZFwiYM8Hn5QCMAs5 |
|PIVX: | DQq2qeny1TveZDcZFWwQVGdKchFGtzeieU |
|Ripple: | rLHzPsX6oXkzU2qL12kHCH8G8cnZv1rBJh
Destination Tag: 2357564055 |
|Monero: | 4GdoN7NCTi8a5gZug7PrwZNKjvHFmKeV11L6pNJPgj5QNEHsN6eeX3D
↪aAQFwZ1ufD4LYCZKArktt113W7QjWvQ7CWDXrwM8yCGgEdhV3Wt|
// Steven Jenkins De Haro ("StevenJDH" on GitHub)