https://github.com/galexrt/container-node_exporter-textfiles

Container Image for easily running textfile exporter scripts to be collected by the prometheus/node_exporter.
https://github.com/galexrt/container-node_exporter-textfiles

docker kubernetes prometheus prometheus-exporter

Last synced: 2 months ago
JSON representation

Container Image for easily running textfile exporter scripts to be collected by the prometheus/node_exporter.

• Host: GitHub
• URL: https://github.com/galexrt/container-node_exporter-textfiles
• Owner: galexrt
• License: mit
• Created: 2017-12-12T01:22:56.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T13:13:05.000Z (2 months ago)
• Last Synced: 2024-07-22T15:42:44.557Z (2 months ago)
• Topics: docker, kubernetes, prometheus, prometheus-exporter
• Language: Smarty
• Homepage:
• Size: 88.9 KB
• Stars: 17
• Watchers: 3
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# container-node_exporter-textfiles

    

        NOTICE The repository and image have been renamed on 18.02.2022! For more information click this spoiler

    

    The container images name has been changed from `galexrt/node-exporter-smartmon` to **`galexrt/node-exporter-textfiles`**.

    E.g., the image on quay.io is now available at `quay.io/galexrt/node-exporter-smartmon`.

    The repository name has been changed from `container-node_exporter-smartmon` to **`container-node_exporter-textfiles`**.

    This has been done as the image in this repository is not just for running the `smartmon` textfile collector script(s) anymore.

Container Image for easily running textfile exporter scripts from the Prometheus Community to be collected by the prometheus/node_exporter.

Container Image available from:

* [Quay.io](https://quay.io/repository/galexrt/node-exporter-textfiles)

* [GHCR.io](https://github.com/users/galexrt/packages/container/package/node-exporter-textfiles)

Container Image Tags:

* `main` - Latest build of the `main` branch.

* `vYYYYmmdd-HHMMSS-NNN` - Latest build of the application with date of the build.

## Credits

This docker image contains the [prometheus-community/node-exporter-textfile-collector-scripts](https://github.com/prometheus-community/node-exporter-textfile-collector-scripts) repository, so that any script can be easily used with / from this Docker image.

## Usage

**This Docker image needs to be run in privileged mode for most of the scripts in the `prometheus-community/node-exporter-textfile-collector-scripts` repository, e.g., for `smartmon.sh` it is needed to be able to collect the SMART values.**

The entrypoint script is putting the output into the directory `/var/lib/node_exporter`, by default filename named after which script is running.

### Variables

| Name              | Default       | Description                                                      |

| ----------------- | ------------- | ---------------------------------------------------------------- |

| `SCRIPT`          | `smartmon.sh` | Which of the node_exporter textfile collector scripts to run.    |

| `OUTPUT_FILENAME` | `smartmon`    | Name of the output file (file ending must not be added `.prom`). |

| `INTERVAL`        | `300`         | Interval at which to run the script at.                          |

Any flags / args given to the container are passed to the `SCRIPT` that will be executed.

## Grafana Dashboard

A Grafana dashboard for viewing `smartmon` metrics can be found in the [`grafana/`](grafana/) directory and [Grafana.com - Smartmon Textfile Dashboard by Galexrt](https://grafana.com/dashboards/3992).

## Required node_exporter Configuration

See [node_exporter Configuration Prerequisites](docs/node_exporter.md).

## Kubernetes

Following deployments / installation methods are available:

* [`node-exporter-textfiles` Helm Chart](charts/node-exporter-textfiles) (Recommended)

* [`kubernetes/`](kubernetes/) directory contains an example DaemonSet running the `smartmon.sh` and `nvme_metrics.sh` textfile scripts.