Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikhail Grigorev committed Feb 25, 2025
1 parent ba556b9 commit 54b12c3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This project is a continuation of the development of the original pgSCV by [Alex
- **OS metrics:** support collecting metrics of operating system (only Linux).
- **Support Prometheus service discovery.** `/targets` endpoint is used to discover all monitoring services ([see documentation](https://github.com/cherts/pgscv/wiki/Service-discovery))
- **Throttling support** The throttling allows limiting calls to the `/metrics` and `/metrics?target=xxx` endpoints to protect databases from a flood of monitoring requests from multiple collection agents ([see documentation](https://github.com/cherts/pgscv/wiki/Throttling)).
- **Concurrency limitting support** It is possible to limit the parallel collection of monitoring data from the database to control the load created by the exporter. ([see documentatio](https://github.com/cherts/pgscv/wiki/Сoncurrency)).
- **TLS and authentication**. `/metrics` and и `/metrics?target=xxx` endpoint could be protected with basic authentication and TLS.
- **Collecting metrics from multiple services**. pgSCV can collect metrics from many databases instances.
- **User-defined metrics**. pgSCV could be configured in a way to collect metrics defined by user.
Expand All @@ -39,7 +40,7 @@ This project is a continuation of the development of the original pgSCV by [Alex
Download the archive from [releases](https://github.com/cherts/pgscv/releases). Unpack the archive. Create minimum config file. Start pgSCV systemd service under `postgres` user.

```bash
curl -s -L https://github.com/cherts/pgscv/releases/download/v0.12.0/pgscv_0.12.0_linux_$(uname -m).tar.gz -o - | tar xzf - -C /tmp && \
curl -s -L https://github.com/cherts/pgscv/releases/download/v0.13.0/pgscv_0.13.0_linux_$(uname -m).tar.gz -o - | tar xzf - -C /tmp && \
mv /tmp/pgscv.yaml /etc && \
mv /tmp/pgscv.service /etc/systemd/system && \
mv /tmp/pgscv.default /etc/default/pgscv && \
Expand Down
3 changes: 2 additions & 1 deletion README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- **Метрики ОС:** поддержка сбора показателей работы операционной системы (только Linux);
- **Поддержка обнаружения сервисов мониторинга** Через специальный эндпойнт `/targets` можно производить обнаружение всех сервисов мониторинга ([смотри документацию](https://github.com/cherts/pgscv/wiki/Service-discovery))
- **Поддержка тротлинга** Механизм тротлинга позволяет лимитировать обращения к эндпойнтам `/metrics` и `/metrics?target=xxx` для защиты баз данных от потока запросов мониторинга от множества агентов сбора метрик ([смотри документацию](https://github.com/cherts/pgscv/wiki/Throttling)).
- **Поддержка контроля параллелизма** Можно ограничить возможности параллельного сбора данных мониторинга из базы данных для контроля нагрузки создаваемой экспортером ([смотри документацию](https://github.com/cherts/pgscv/wiki/Сoncurrency)).
- **TLS и аутентификация**: Эндпойнты `/metrics` и `/metrics?target=xxx` могут быть защищены с помощью базовой аутентификации и TLS;
- **Сбор показателей из нескольких сервисов**: pgSCV может собирать метрики из многих экземпляров баз данных, включая базы данных расположенные в облачных средах (Amazon AWS, Yandex.Cloud, VK.Cloud);
- **Настраиваемые пользовательские метрики**: pgSCV можно настроить на сбор кастомных пользовательских метрик;
Expand All @@ -32,7 +33,7 @@
Загрузите архив со страницы [releases](https://github.com/cherts/pgscv/releases). Распакуйте архив. Создайте минимальный файл конфигураации. Запустите pgSCV под пользователем postgres.

```bash
curl -s -L https://github.com/cherts/pgscv/releases/download/v0.12.0/pgscv_0.12.0_linux_$(uname -m).tar.gz -o - | tar xzf - -C /tmp && \
curl -s -L https://github.com/cherts/pgscv/releases/download/v0.13.0/pgscv_0.13.0_linux_$(uname -m).tar.gz -o - | tar xzf - -C /tmp && \
mv /tmp/pgscv.yaml /etc && \
mv /tmp/pgscv.service /etc/systemd/system && \
mv /tmp/pgscv.default /etc/default/pgscv && \
Expand Down

0 comments on commit 54b12c3

Please sign in to comment.