<commit_before>#  :chart_with_upwards_trend: promplot

[![GoDoc](https://godoc.org/qvl.io/promplot?status.svg)](https://godoc.org/qvl.io/promplot)
[![Build Status](https://travis-ci.org/qvl/promplot.svg?branch=master)](https://travis-ci.org/qvl/promplot)
[![Go Report Card](https://goreportcard.com/badge/qvl.io/promplot)](https://goreportcard.com/report/qvl.io/promplot)


`promplot` is an opinionated tool to create plots from your [Prometheus](https://prometheus.io/) metrics and automatically sends them to you.


**Slack example:**

``` sh
promplot -title "Open File Descriptors" -query "process_open_fds" -range "7d" -url $promurl -slack $slacktoken -channel stats
```

![Demo Screenshot](screenshot.png)

Currently the only implemented transport is [Slack](https://slack.com/).
But feel free to [add a new one](#development)!


    Usage: promplot [flags...]

    Create and deliver plots from your Prometheus metrics.

    Save plot to file or send it right to a slack channel.
    At least one of -slack or -file must be set.


    Flags:
      -channel string
            Required when -slack is set. Slack channel to post to.
      -file string
            File to save image to. Should have same extension as specified -format. Set -file to - to write to stdout.
      -format string
            Optional. Image format. For possible values see: https://godoc.org/github.com/gonum/plot/vg/draw#NewFormattedCanvas (default "png")
      -query string
            Required. PQL query.
      -range duration
            Required. Time to look back to. Format: 12h34m56s.
      -silent
            Optional. Suppress all output.
      -slack string
            Slack API token (https://api.slack.com/docs/oauth-test-tokens). Set to post plot to Slack.
      -time value
            Required. Time for query (default is now). Format like the default format of the Unix date command. (default Fri Feb 10 14:39:36 CET 2017)
      -title string
            Optional. Title of graph. (default "Prometheus metrics")
      -url string
            Required. URL of Prometheus server.
      -version
            Optional. Print binary version.


## Install
<commit_msg>Update help output in readme.<commit_after>#  :chart_with_upwards_trend: promplot

[![GoDoc](https://godoc.org/qvl.io/promplot?status.svg)](https://godoc.org/qvl.io/promplot)
[![Build Status](https://travis-ci.org/qvl/promplot.svg?branch=master)](https://travis-ci.org/qvl/promplot)
[![Go Report Card](https://goreportcard.com/badge/qvl.io/promplot)](https://goreportcard.com/report/qvl.io/promplot)


`promplot` is an opinionated tool to create plots from your [Prometheus](https://prometheus.io/) metrics and automatically sends them to you.


**Slack example:**

``` sh
promplot -title "Open File Descriptors" -query "process_open_fds" -range "7d" -url $promurl -slack $slacktoken -channel stats
```

![Demo Screenshot](screenshot.png)

Currently the only implemented transport is [Slack](https://slack.com/).
But feel free to [add a new one](#development)!


    Usage: promplot [flags...]

    Create and deliver plots from your Prometheus metrics.

    Save plot to file or send it right to a slack channel.
    One of -slack or -file must be set.


    Flags:
      -channel string
            Required when -slack is set. Slack channel to post to.
      -file string
            File to save image to. Should have same extension as specified -format. Set -file to - to write to stdout.
      -format string
            Optional. Image format. For possible values see: https://godoc.org/github.com/gonum/plot/vg/draw#NewFormattedCanvas (default "png")
      -query string
            Required. PQL query.
      -range value
            Required. Time to look back to. Format: 5d12h34m56s
      -silent
            Optional. Suppress all output.
      -slack string
            Slack API token (https://api.slack.com/docs/oauth-test-tokens). Set to post plot to Slack.
      -time value
            Time for query (default is now). Format like the default format of the Unix date command.
      -title string
            Optional. Title of graph. (default "Prometheus metrics")
      -url string
            Required. URL of Prometheus server.
      -version
            Optional. Print binary version.


## Install

{'fraction_non_alphanumeric': 0.10750932835820895, 'fraction_numerical': 0.006296641791044776, 'mean_word_length': 2.703799654576857, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2513033', 'n_tokens_mistral': 1332, 'n_tokens_neox': 1254, 'n_words': 436}