README.md

ipvs-exporter

Simple server that scrapes Linux kernel module ip_vs stats through ipvs and exports them via HTTP for Prometheus consumption

This repo starts with nginx-vts-exporter, many thanks to hnlq715.

Table of Contents

• Dependency
• Download
• Compile
  • build binary
  • build docker image
• Run
  • run binary
  • run docker image
• Environment variables
• Authors
• Copyright and License

Dependency

• ipvs
• Prometheus
• Golang

Back to TOC

Download

Binary can be downloaded from Releases page.

Back to TOC

Compile

build binary

make

build RPM package

make rpm

build docker image

make docker

Docker Hub Image

docker pull kwanhur/ipvs-exporter:latest

It can be used directly instead of having to build the image yourself. (Docker Hub kwanhur/ipvs-exporter)

Back to TOC

Run

run binary

nohup /usr/bin/ipvs-exporter

run docker

docker run  -ti --rm kwanhur/ipvs-exporter

Back to TOC

Environment variables

This image is configurable using different env variables

Variable name	Default	Description
METRICS_ENDPOINT	/metrics	Metrics endpoint exportation URI
METRICS_ADDR	:9911	Metrics exportation address:port
METRICS_NS	ipvs	Prometheus metrics Namespaces

Back to TOC

Authors

kwanhur [email protected]

Back to TOC

Copyright and License

This module is licensed under the Apache License 2.0 .

Copyright (C) 2020, by kwanhur [email protected]

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC