arjunsaurus/watchdog

Bridging the gap between the intricate Kubernetes monitoring and the sheer convenience of real-time monitoring, all from the command line.

WatchDogCLI

Simple, custom command line monitoring for local kubernetes development.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

Getting Started

Prerequisites

1. Install Minikube

2. Install Docker

3. Ensure minikube is running

   minikube start

Installation

1. Install NPM package

   npm install watchdogcli

2. Configure local metrics server

   watchdog --start

(back to top)

Usage

1. List pods/containers/nodes

   watchdog --[resourcetype]

   

2. Set a CPU usage alert threshold for a pod

   watchdog --cpuwatch 70

   

3. Provide crash alerts (as well as any CPU alerts set prior with --cpuwatch)

   watchdog --watch

4. Get metrics for all pods

   watchdog --metrics

Complete List of Commands

Command	Description
--start	Installs metric server
--pods	Displays all running pods
--nodes	Displays all running nodes
--containers	Displays all running containers
--metrics	Displays metrics for a specific pod
--nodeusage	Displays metrics for the one node
--podusage	Displays metrics for a specific pod
--podpercent	Displays metric percent for a specific pod
--cpuwatch	Sets a pod CPU usage alert threshold (note: include a number after a space after the flag)
--watch	Runs watchdog to provide pod crash, pod start, and CPU threshold alerts (set prior using --cpuwatch)
--help	Displays available commands
--wizard	Launches a help wizard

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ajax Abernathy - @linkedIn

Arjun V - @linkedIn

Jerry Perez - @linkedIn

Oliver Wendell-Braly - @linkedIn

Project Link: https://github.com/oslabs-beta/WatchDog

Team Website: https://www.getwatchdog.io

(back to top)