https://github.com/adhocteam/script_exporter

Shell script prometheus exporter
https://github.com/adhocteam/script_exporter

Last synced: about 2 months ago
JSON representation

Shell script prometheus exporter

• Host: GitHub
• URL: https://github.com/adhocteam/script_exporter
• Owner: adhocteam
• License: mit
• Created: 2016-11-16T17:03:31.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-13T10:50:37.000Z (over 1 year ago)
• Last Synced: 2024-08-02T15:48:07.147Z (5 months ago)
• Language: Go
• Size: 45.9 KB
• Stars: 195
• Watchers: 7
• Forks: 52
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Script Exporter

GitHub: https://github.com/adhocteam/script_exporter

Prometheus exporter written to execute and collect metrics on script exit status

and duration. Designed to allow the execution of probes where support for the

probe type wasn't easily configured with the Prometheus blackbox exporter.

Minimum supported Go Version: 1.13.1

## Sample Configuration

```yaml

scripts:

  - name: success

    script: sleep 5

  - name: failure

    script: sleep 2 && exit 1

  - name: timeout

    script: sleep 5

    timeout: 1

```

## Running

You can run via docker with:

```

docker run -d -p 9172:9172 --name script-exporter \

  -v `pwd`/script-exporter.yml:/etc/script-exporter/config.yml:ro \

  adhocteam/script-exporter:master \

  -config.file=/etc/script-exporter/config.yml \

  -web.listen-address=":9172" \

  -web.telemetry-path="/metrics" \

  -config.shell="/bin/sh"

```

You'll need to customize the docker image or use the binary on the host system

to install tools such as curl for certain scenarios.

## Probing

To return the script exporter internal metrics exposed by the default Prometheus

handler:

`$ curl http://localhost:9172/metrics`

To execute a script, use the `name` parameter to the `/probe` endpoint:

`$ curl http://localhost:9172/probe?name=failure`

```

script_duration_seconds{script="failure"} 2.008337

script_success{script="failure"} 0

```

A regular expression may be specified with the `pattern` paremeter:

`$ curl http://localhost:9172/probe?pattern=.*`

```

script_duration_seconds{script="timeout"} 1.005727

script_success{script="timeout"} 0

script_duration_seconds{script="failure"} 2.015021

script_success{script="failure"} 0

script_duration_seconds{script="success"} 5.013670

script_success{script="success"} 1

```

## Design

YMMV if you're attempting to execute a large number of scripts, and you'd be

better off creating an exporter that can handle your protocol without launching

shell processes for each scrape.