https://github.com/hypnoglow/go-pg-monitor

📊 Exposes Prometheus metrics for go-pg database client stats.
https://github.com/hypnoglow/go-pg-monitor

go go-metrics go-pg golang grafana postgres prometheus

Last synced: 24 days ago
JSON representation

📊 Exposes Prometheus metrics for go-pg database client stats.

• Host: GitHub
• URL: https://github.com/hypnoglow/go-pg-monitor
• Owner: hypnoglow
• License: apache-2.0
• Created: 2020-11-13T19:33:00.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-01T19:39:20.000Z (3 months ago)
• Last Synced: 2024-09-30T08:03:14.930Z (about 1 month ago)
• Topics: go, go-metrics, go-pg, golang, grafana, postgres, prometheus
• Language: Go
• Homepage:
• Size: 144 KB
• Stars: 14
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-pg-monitor

[![Go Reference](https://pkg.go.dev/badge/github.com/hypnoglow/go-pg-monitor.svg)](https://pkg.go.dev/github.com/hypnoglow/go-pg-monitor)

![Maintenance](https://img.shields.io/maintenance/yes/2024)

[![main](https://github.com/hypnoglow/go-pg-monitor/actions/workflows/main.yml/badge.svg)](https://github.com/hypnoglow/go-pg-monitor/actions/workflows/main.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/hypnoglow/go-pg-monitor)](https://goreportcard.com/report/github.com/hypnoglow/go-pg-monitor)

Provides Prometheus metrics for [go-pg](https://github.com/go-pg/pg) database client.

Example Grafana dashboards:

![grafana](.github/images/grafana.png)

## Status

This package is now stable.

As the [go-pg](https://github.com/go-pg/pg) is in a maintenance mode, it is unlikely

that new features will be introduced in this package. Fixing bugs and security issues

will continue.

## Usage

0. Your application should already be using go-pg and exporting Prometheus metrics.

1. Add the module to your project:

    ```shell

    go get github.com/hypnoglow/go-pg-monitor

    ```

   

   Also add the submodule with the go-pg version you use:

    ```shell

    go get github.com/hypnoglow/go-pg-monitor/gopgv10

    ```

2. Add monitor to your application entrypoint:

    ```go

    // Create monitor based on your *pg.DB

    mon := monitor.NewMonitor(

		gopgv10.NewObserver(db),

		monitor.NewMetrics(),

	)

   

    // Call this on application startup. 

    mon.Open()

	

    // Call this on application shutdown.

    mon.Close()

    ```

See [example](example/main.go) for details.

## Exported metrics

- `go_pg_pool_hits` - (Gauge) Number of times free connection was found in the pool

- `go_pg_pool_misses` - (Gauge) Number of times free connection was NOT found in the pool

- `go_pg_pool_timeouts` - (Gauge) Number of times a wait timeout occurred

- `go_pg_pool_total_connections` - (Gauge) Number of total connections in the pool

- `go_pg_pool_idle_connections` - (Gauge) Number of idle connections in the pool

- `go_pg_pool_stale_connections` - (Gauge) Number of stale connections removed from the pool

## Reference Grafana Dashboards

You can find two example Grafana dashboards in [grafana/](grafana/) directory. 

[One]() may be suitable when you use only one database object

in your application code, and the [other]() when

you use different objects (pools) for different parts of the application.

Note that your dashboard may be different if you use metric namespace, different k8s labels, etc.

So these dashboards are provided only as a starting point for making your own.