exporter-template

README

exporter-template

The exporter-template is a basic Prometheus exporter, written in Go. The goal of this project is to provide a minimal start point from which any exporter may start. It contains a minimal set of features common to any exporter.

Getting Started

In summary, copy this project's code to get your exporter started.

Prerequisites

To run this project, you will need a working Go environment.

Installing

go get -u github.com/FXinnovation/exporter-template

Running the tests

make test

Usage

./exporter-template -h

Deployment

The template listen on port 1984 by default, be sure to change that port in order to suit your new exporter needs.

Docker image

You can build a docker image using:

make docker

The resulting image is named fxinnovation/exporter-template:{git-branch}. It exposes port 1984 and expects the config in /config.yml. To configure it, you can bind-mount a config from your host:

$ docker run -p 1984 -v /path/on/host/config.yml:/config.yml fxinnovation/exporter-template:master

Contributing

Refer to CONTRIBUTING.md.

License

Apache License 2.0, see LICENSE.