{"id":20643865,"url":"https://github.com/adjust/pg-telemetry","last_synced_at":"2025-03-09T14:33:12.046Z","repository":{"id":23717744,"uuid":"99132335","full_name":"adjust/pg-telemetry","owner":"adjust","description":"Useful monitoring views for PostgreSQL, packaged as an extension","archived":false,"fork":false,"pushed_at":"2024-07-06T18:06:26.000Z","size":88,"stargazers_count":24,"open_issues_count":5,"forks_count":7,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-01-17T09:11:54.064Z","etag":null,"topics":["adjust-pg-extension"],"latest_commit_sha":null,"homepage":"","language":"PLpgSQL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adjust.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-02T15:26:35.000Z","updated_at":"2024-11-28T16:33:28.000Z","dependencies_parsed_at":"2025-01-17T09:11:54.430Z","dependency_job_id":"a5773881-d302-45f7-816d-2099656d8408","html_url":"https://github.com/adjust/pg-telemetry","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fpg-telemetry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fpg-telemetry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fpg-telemetry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fpg-telemetry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adjust","download_url":"https://codeload.github.com/adjust/pg-telemetry/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242705596,"owners_count":20172325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adjust-pg-extension"],"created_at":"2024-11-16T16:14:09.621Z","updated_at":"2025-03-09T14:33:12.013Z","avatar_url":"https://github.com/adjust.png","language":"PLpgSQL","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![TEST](https://github.com/adjust/pg-telemetry/actions/workflows/test.yml/badge.svg)](https://github.com/adjust/pg-telemetry/actions/workflows/test.yml)\n\n\n# pg_telemetry, an extension for getting usage states from PostgreSQL\n\nWelcome to pg_telemetry, an extension for monitoring usage of PostgreSQL.\n\nThis module provides functions for deriving usage stats from system stats\nand other system administration functions.  It aims to provide a generally\nuseful and reusable series of metrics functions for monitoring purposes.\n\nMost of the data is set to export numbers and can be used to supply SNMP\nagents, Zabbix agents, and other monitoring programs with data.\n\n## Intended Usage\n\nThe module is intended to be used with monitoring and visualizaiton\nprograms such as pganalyze, zabbix, and munin.  These tend to use an agent\nwhich collects performance data and sends it to a server for graphics\ngeneration.  Some of the functions here are wrapped in views.\n\nA second class of functions are in place for administrators to use in\ntroubleshooting and debugging performance issues.  However these are to be\nused as needed while the general stats functions are assumed to be run\nevery few min at least.\n\nWe expect this extension usually to be installed in its own schema.\nHowever, it can be safely installed anywhere its names don't conflict\nwith anything else.\n\n## Areas of focus\n\nIn the initial phase, there are several areas of focus for this project:\n\n * Disk usage\n * Sources of concurrent queries\n * WAL throughput\n * Replication Monitoring\n\n## Requirements\n\nCurrently this is expected to require PostgreSQL 10+.\n\nThis module also requires that pg_stat_statements is installed.\n\n## Documentation of monitoring views, relations, and functions\n\nSee the [pgtelemetry.html](doc/pgtelemetry.html) in the doc folder.\n\n## Installation\n\npg_stats_statements must be installed and preloaded.  Once that is the case,\nyou can use the standard make/make install process to install this extension:\n\n    make install\n\nThat copies the files into the PostgreSQL extensions directory.  In some\ncases (Windows) you may need to install appropriate development tools\nsuch as MinGW and on Linux in some cases you may need the development\nlibraries.\n\nAfter that, in the database you want to base your monitoring on:\n\n    create extension pgtelemetry;\n\nThis will create the pgtelemetry schema and place all the objects there.\n\n## Extras\n\nIn the extras directory there are a number of important integration examples.\n\nextras/prometheus:\n\n   * queries.yaml includes a basic yaml for pulling stats into Prometheus\n   * queries_wal.yaml is a basic wal telemetry yaml that can be run on\nmaster databasess\n\nextras/zabbix:\n\n   * checkTablespaceSize.pl raises an alarm if any tablespace is too big\n   * checkNoLongRunningQueries.pl raises an alarm if queries have been\n     running too long.\n   * checkWaitingQueries.pl raises an alarm if too many queries are\n     waiting on locks and latches.\n   * checkReplicationLag.pl raises an alarm if replication lag is too\n     high (checks downstream).\n\nWhat is too big?  To high?  Too long?  These are set in the beginning\nof the scripts making this easy to integrate with Zabbix.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadjust%2Fpg-telemetry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadjust%2Fpg-telemetry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadjust%2Fpg-telemetry/lists"}