prometheus

README

Prometheus components for Golang

This module is a part of the Pip.Services polyglot microservices toolkit.

The module contains components for working with meters in the Prometheus service. The PrometheusCounters and PrometheusMetricsController components allow you to work both in client mode through PushGateway, and as a service.

The module contains the following packages:

• Build - the default factories for constructing components.
• Count - components of counters (metrics) with sending data to Prometheus via PushGateway
• Services - components of the service for reading counters (metrics) by the Prometheus service

Quick links:

• Configuration
• API Reference
• Change Log
• Get Help
• Contribute

Use

Get the package from the Github repository:

go get -u github.com/pip-services4/pip-services4-go/pip-services4-prometheus-go@latest

Develop

For development you shall install the following prerequisites:

• Golang v1.20+
• Visual Studio Code or another IDE of your choice
• Docker
• Git

Run automated tests:

go test -v ./test/...

Generate API documentation:

./docgen.ps1

Before committing changes run dockerized test as:

./test.ps1
./clear.ps1

Contacts

The library is created and maintained by Sergey Seroukhov and Levichev Dmitry.

The documentation is written by:

• Levichev Dmitry