https://github.com/gree-gorey/bash-exporter

Simple & minimalistic Prometheus exporter for bash scripts, written in Go
https://github.com/gree-gorey/bash-exporter

bash go golang metrics prometheus prometheus-exporter prometheus-metrics

Last synced: 7 days ago
JSON representation

Simple & minimalistic Prometheus exporter for bash scripts, written in Go

• Host: GitHub
• URL: https://github.com/gree-gorey/bash-exporter
• Owner: gree-gorey
• License: apache-2.0
• Created: 2018-07-06T07:35:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-24T19:47:30.000Z (about 1 year ago)
• Last Synced: 2024-08-02T15:47:37.258Z (3 months ago)
• Topics: bash, go, golang, metrics, prometheus, prometheus-exporter, prometheus-metrics
• Language: Go
• Homepage: https://github.com/gree-gorey/bash-exporter
• Size: 20.5 KB
• Stars: 65
• Watchers: 6
• Forks: 29
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Prometheus bash exporter

Simple & minimalistic Prometheus exporter for bash scripts.

[![Go Report Card](https://goreportcard.com/badge/github.com/gree-gorey/bash-exporter)](https://goreportcard.com/report/github.com/gree-gorey/bash-exporter)  

[![](https://images.microbadger.com/badges/image/greegorey/bash-exporter.svg)](https://microbadger.com/images/greegorey/bash-exporter "Get your own image badge on microbadger.com")

[![](https://images.microbadger.com/badges/version/greegorey/bash-exporter.svg)](https://microbadger.com/images/greegorey/bash-exporter "Get your own version badge on microbadger.com")

## Installation

Use [Docker image](https://hub.docker.com/r/greegorey/bash-exporter/) or binary file from [releases](https://github.com/gree-gorey/bash-exporter/releases).

## Docker quick start

```console

$ docker run -v $PWD/examples:/scripts -p 9300:9300 greegorey/bash-exporter:2.0.0

```

```console

$ curl -s 127.1:9300/metrics | grep ^bash

bash{env="",hostname="node-1",job="job-2",verb="get"} 0.003

bash{env="",hostname="node-1",job="job-2",verb="put"} 0.13

bash{env="",hostname="node-1",job="job-2",verb="time"} 0.5

bash{env="dev",hostname="",job="job-1",verb="items"} 21

```

## Usage

```console

Usage of ./bash-exporter:

  -debug

    	Debug log level

  -interval int

    	Interval for metrics collection in seconds (default 300)

  -labels string

    	additioanal labels (default "hostname,env")

  -path string

    	path to directory with bash scripts (default "/scripts")

  -prefix string

    	Prefix for metrics (default "bash")

  -web.listen-address string

    	Address on which to expose metrics (default ":9300")

```  

Just point `-path` flag to the directory with your bash scripts. Names of the files (`(.*).sh`) will be used as the `job` label. Bash scripts should return valid json (see [examples](https://github.com/gree-gorey/bash-exporter/tree/master/examples)).

Example output:

```console

# HELP bash bash exporter metrics

# TYPE bash gauge

bash{job="job-1",verb="items"} 21

bash{job="job-2",verb="get"} 0.003

bash{job="job-2",verb="put"} 0.13

bash{job="job-2",verb="time"} 0.5

...

```

## TODO

- [x] Docker image

- [x] Several scripts