Code Monkey home page Code Monkey logo

grafterm's Introduction

Grafterm CircleCI

Visualize metrics dashboards on the terminal, like a simplified and minimalist version of Grafana for terminal.

grafterm red dashboard

Features

  • Multiple widgets (graph, singlestat, gauge).
  • Multiple datasources usage (including aggregation).
  • Custom dashboards based on JSON configuration files.
  • Extensible metrics datasource implementation (Prometheus included).
  • Templating of variables.
  • Auto time interval adjustment for queries.
  • Auto unit formatting on widgets.
  • Fixed and adaptive grid.
  • Color customization on widgets.
  • Configurable autorefresh.
  • Single binary and easy usage/deployment.

Installation

Download the binaries from releases

Run examples

Simple run:

grafterm -c ./mydashboard.json

Setting a relative time duration:

grafterm -c ./mydashboard.json -d 48h

Setting a fixed time range to visualize the metrics using duration notation. In this example is start at now-22h and end at now-20h

grafterm -c ./mydashboard.json -s 22h -e 20h

Setting a fixed time range to visualize the metrics using timestamp ISO 8601 notation.

grafterm -c ./mydashboard.json -s 2019-05-12T12:32:11+02:00 -e 2019-05-12T12:35:11+02:00

Replacing dashboard variables:

grafterm -c ./mydashboard.json -v env=prod -v job=envoy

Dashboard

Check this section that explains how a dashboard is configured. Also check dashboard examples

Datasources

Datasources are the way grafterm knows how to retrieve the metrics for the dashboard. these are the datasources supported at this moment:

  • Prometheus

Open an issue or a PR to support more datasource types.

Kudos

This project would not be possible without the effort of many people and projects but specially Grafana for the inspiration, ideas and the project itself, and Termdash for the rendering of all those fancy graphs on the terminal.

grafterm's People

Contributors

slok avatar

Stargazers

Sergio Rubio avatar

Watchers

Christian Muehlhaeuser avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.