Skip to content
This repository has been archived by the owner on Aug 22, 2024. It is now read-only.

Commit

Permalink
Docs: add features page, edit README.
Browse files Browse the repository at this point in the history
  • Loading branch information
lesovsky committed Feb 27, 2021
1 parent 9a78cb3 commit 9ed9d44
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,21 @@
---

### pgSCV
- primarily developed for needs of [Weaponry](https://weaponry.io).
- [collects](./doc/collectors.md) a lot of stats about system, PostgreSQL, Pgbouncers, etc
- [collects](./doc/collectors.md) a lot of stats about system, PostgreSQL, Pgbouncers, etc.
- provides all metrics through well-known /metrics endpoint in [Prometheus metrics exposition format](https://prometheus.io/docs/concepts/data_model/).
- could be configured
- could be configured:
1. in standalone listening-only mode for serving requests from Prometheus.
2. in combined listening-and-sending mode for sending collected metrics to Weaponry SaaS.
- can run on Linux only, but [can connect](doc/usage-en.md) to remote services running on other OS.
2. in combined listening-and-sending mode for sending collected metrics to [Weaponry](https://weaponry.io) SaaS.
- can run on Linux only, but [can connect](doc/usage-en.md) to remote services running on other OS.
- include features developed for needs of [Weaponry](https://weaponry.io) users, but might be useless for non-Weaponry users.
- for further info see full list of features.

### Support
If you need help using pgSCV feel free to open discussion or create an [issue](https://github.com/weaponry/pgscv/issues)

### Development and contribution
To help development you are encouraged to:
- provide suggestion/feedback/issue
- provide [suggestion/feedback](https://github.com/weaponry/pgscv/discussions) or [issue](https://github.com/weaponry/pgscv/issues)
- pull requests for new features
- star the project

Expand Down
31 changes: 31 additions & 0 deletions doc/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Features

List of available features. List of available collectors available [here](./collectors.md)

---

- Collecting metrics:
- System stats
- PostgreSQL stats, logs
- Pgbouncer stats


- Selective disabling of specific collectors. Users might disable specific collectors if some metrics are not needed.


- Expose metrics in [Prometheus metrics exposition format](https://prometheus.io/docs/concepts/data_model/). Metrics are
available through standard HTTP `/metrics` endpoint.


- Services auto-discovery. pgSCV can discover services running on the same host where pgSCV is running and automatically
start collecting metrics.
- PostgreSQL services
- Pgbouncer services


- Remote service connecting. pgSCV can connect to remote services using user-provided requisites.


- Auto-update. pgSCV can track Github Releases page for new releases and automatically update itself. Mainly this feature
exists for [Weaponry](https://weaponry.io) users for automatic pgSCV updates and allow delivering new Weaponry features
quickly.

0 comments on commit 9ed9d44

Please sign in to comment.