1.2.0 • Published 8 months ago

watchdogcli v1.2.0

Weekly downloads
-
License
ISC
Repository
github
Last release
8 months ago

Contributors Forks Stargazers Issues MIT License LinkedIn

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

Usage

  1. List pods/containers/nodes
    watchdog --[resourcetype]
  1. Set a CPU usage alert threshold for a pod
    watchdog --cpuwatch 70
  1. Provide crash alerts (as well as any CPU alerts set prior with --cpuwatch)
    watchdog --watch
  1. Get metrics for all pods
    watchdog --metrics

Complete List of Commands

CommandDescription
--startInstalls metric server
--podsDisplays all running pods
--nodesDisplays all running nodes
--containersDisplays all running containers
--metricsDisplays metrics for a specific pod
--nodeusageDisplays metrics for the one node
--podusageDisplays metrics for a specific pod
--podpercentDisplays metric percent for a specific pod
--cpuwatchSets a pod CPU usage alert threshold (note: include a number after a space after the flag)
--watchRuns watchdog to provide pod crash, pod start, and CPU threshold alerts (set prior using --cpuwatch)
--helpDisplays available commands
--wizardLaunches a help wizard

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

License

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

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

1.2.0

8 months ago

1.1.0

8 months ago

1.0.0

8 months ago