Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/a0s/files-content-exporter

Exports file's content as Prometheus metrics
https://github.com/a0s/files-content-exporter

Last synced: 7 days ago
JSON representation

Exports file's content as Prometheus metrics

Host: GitHub
URL: https://github.com/a0s/files-content-exporter
Owner: a0s
License: mit
Created: 2018-06-21T23:27:39.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2020-08-26T12:08:47.000Z (about 4 years ago)
Last Synced: 2023-03-24T00:32:26.529Z (over 1 year ago)
Language: Go
Homepage:
Size: 44.9 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        files-content-exporter

======================

[![GitHub release](https://img.shields.io/github/release/a0s/files-content-exporter.svg)](https://github.com/a0s/files-content-exporter/releases/latest)

[![Binary release](https://github.com/a0s/files-content-exporter/workflows/Binary%20release/badge.svg)](https://github.com/a0s/files-content-exporter/releases/latest)

[![Docker image](https://github.com/a0s/files-content-exporter/workflows/Docker%20image/badge.svg)](https://hub.docker.com/repository/docker/a00s/files-content-exporter)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Exports file's content as Prometheus metric

Releases

--------

* static linked binary: [linux/amd64](https://github.com/a0s/files-content-exporter/releases/latest/download/files-content-exporter-amd64.tar.gz), [linux/arm64](https://github.com/a0s/files-content-exporter/releases/latest/download/files-content-exporter-arm64.tar.gz), [linux/armv6](https://github.com/a0s/files-content-exporter/releases/latest/download/files-content-exporter-armv6.tar.gz), [linux/armv7](https://github.com/a0s/files-content-exporter/releases/latest/download/files-content-exporter-armv7.tar.gz)

* docker image: [a00s/files-content-exporter](https://hub.docker.com/repository/docker/a00s/files-content-exporter)

Settings

--------

* `FILES_CONTENT_EXPORTER_CONFIG_FILE_PATH` | default: _/config.yml_ - path to config.yml

* `FILES_CONTENT_EXPORTER_PORT` | default: _9457_ - port to bind

* `FILES_CONTENT_EXPORTER_HOST` | default: _127.0.0.1_  - host to bind

* `FILES_CONTENT_EXPORTER_LOG_LEVEL` | default: _INFO_ - log level, one of `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`

config.yml

----------

This file describes metrics (entities) which will be export through `/metrics` endpoint. Example of config.yml (`examples/config.yml`) is valid for Cubieboard2. But you are free to use any files as a source of metrics.

> Warn! For entites with same names you *must* use equal help text and labels names. Otherwise you will get _"panic: a previously registered descriptor with the same fully-qualified name as Desc{...} has different label names or a different help string"_

```yaml

path_as_label_enabled: true                                 # [optional] use path to file with metric as `path` label

entities:                                                   # list of entities (one file - one metric)

  - file: /sys/devices/virtual/thermal/thermal_zone0/temp   # [required] path to file with metric

    name: cpu_temp_celsius                                  # [required] metric's name in export

    labels:                                                 # [optional] list of labels, optional

      thermal_zone: 0

    help: CPU thermal 0                                     # [optional] description of metric

  - file: /sys/devices/virtual/thermal/thermal_zone1/temp

    name: cpu_temp_celsius

    labels:

      thermal_zone: 1

    help: CPU thermal 1

  - file: /sys/devices/virtual/thermal/thermal_zone2/temp

    name: cpu_temp_celsius

    labels:

      thermal_zone: 2

    help: CPU thermal 2

  - file: /sys/devices/virtual/thermal/thermal_zone3/temp

    name: cpu_temp_celsius

    labels:

      thermal_zone: 3

    help: CPU thermal 3

  - file: /sys/power/axp_pmu/pmu/temp

    name: pmu_temp_celsius

```

Run as Docker container

---------------------------------------------

```bash

docker run \

  -v /sys:/sys \

  -v `pwd`/examples/config.yml:/config.yml \

  -p 9457:9457 \

  -e FILES_CONTENT_EXPORTER_HOST=0.0.0.0 \

  a00s/files-content-exporter

```

Example response

----------------

```

# HELP cpu_temp_celsius CPU thermal

# TYPE cpu_temp_celsius gauge

cpu_temp_celsius{path="/sys/devices/virtual/thermal/thermal_zone0/temp",thermal_zone="0"} 45200

cpu_temp_celsius{path="/sys/devices/virtual/thermal/thermal_zone1/temp",thermal_zone="1"} 0

cpu_temp_celsius{path="/sys/devices/virtual/thermal/thermal_zone2/temp",thermal_zone="2"} 0

cpu_temp_celsius{path="/sys/devices/virtual/thermal/thermal_zone3/temp",thermal_zone="3"} 0

# HELP pmu_temp_celsius

# TYPE pmu_temp_celsius gauge

pmu_temp_celsius{path="/sys/power/axp_pmu/pmu/temp"} 44500

```