Skip to content

Commit b38792f

Browse files
0xgoudapashagolub
andauthored
[*] mention pgwatch-contrib/rpc in docs (#922)
* add link to sinks options page in `index.md` * mention usage of `--sink` in `sinks_options.md` * add `How To: Implement your own gRPC Server` page to docs * [*] mention `pgwatch-contrib/rpc` instead of `pgwatch_rpc_server` Co-authored-by: Pavlo Golub <[email protected]> * [*] mention `pgwatch-contrib/rpc` Co-authored-by: Pavlo Golub <[email protected]> * rename header to `pgwatch contrib RPC` - substitute all mentions of pgwatch_rpc_server with pgwatch contrib --------- Co-authored-by: Pavlo Golub <[email protected]>
1 parent 691e4d1 commit b38792f

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Implement your own gRPC Server
3+
---
4+
5+
To use pgwatch’s [gRPC sink](../concept/components.md#grpc), you must
6+
provide the URI of a custom gRPC server that integrates with pgwatch using its
7+
[protobuf definition](https://github.com/cybertec-postgresql/pgwatch/blob/master/api/pb/pgwatch.proto).
8+
See also [gRPC Sink URI Parameters](../reference/sinks_options.md#grpc).
9+
10+
## pgwatch contrib RPC
11+
12+
[pgwatch-contrib/rpc](https://github.com/cybertec-postgresql/pgwatch-contrib/tree/main/rpc)
13+
is a **community-maintained** collection of gRPC server implementations for pgwatch.
14+
15+
It provides servers for common data solutions but makes no guarantees about
16+
their suitability for production use. Its main purpose is to provide
17+
examples and building blocks that users can extend to integrate with pgwatch
18+
and develop their own production-ready gRPC servers.
19+
20+
For guidance on implementing a custom gRPC server sink, refer to this
21+
[tutorial](https://github.com/cybertec-postgresql/pgwatch-contrib/blob/main/rpc/TUTORIAL.md).

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ In addition to the standard metrics, pgwatch can be easily extended to monitor *
4040

4141
**Where are the measurements stored and where can users inspect the dashboards?**
4242

43-
- pgwatch allows users to choose from a variety of **storage backends** aka **sinks** for storing monitoring data, such as JSON file, TimescaleDB, Prometheus, PostgreSQL, or a custom gRPC-based backend.
43+
- pgwatch allows users to choose from a variety of **storage backends** aka [**sinks**](./reference/sinks_options.md) for storing monitoring data, such as JSON file, TimescaleDB, Prometheus, PostgreSQL, or a custom gRPC-based backend.
4444
- The **user interface** for pgwatch is powered by **Grafana dashboards**, providing interactive and detailed visualization of the collected metrics. Users can easily view the performance and status of their databases in real-time, drill down into historical data, and configure custom dashboard views based on their preferences.
4545

4646
For a detailed list of all features and capabilities, please refer to the [Features](intro/features.md) page.

docs/reference/sinks_options.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Sinks Options & Parameters
22

3+
- Sinks URIs should be provided to pgwatch via the `--sink` flag, which can be used more than once, see [CLI & Envs](./cli_env.md#sinks).
4+
35
## PostgreSQL
46

57
The PostgreSQL sink URI format is the standard [PostgreSQL connection string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS),
@@ -42,7 +44,7 @@ The gRPC sink URI format is
4244

4345
The gRPC sink supports optional **authentication** and **TLS encryption** over the RPC channel.
4446

45-
For authentication credentials can be provided using the `username:password` format in the URI string,
47+
For authentication, credentials can be provided using the `username:password` format in the URI string,
4648
e.g. `--sink=grpc://user:pwd@localhost:5000/`.
4749
If omitted, defaults to empty string for both username and password.
4850
The values are then forwarded to the gRPC server under the `"username"` and `"password"` fields in the metadata.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ nav:
6767
- Bootstrapping the Configuration Database: howto/config_db_bootstrap.md
6868
- Bootstraping the Measurements Database (Sink): howto/metrics_db_bootstrap.md
6969
- Migration from pgwatch v2: howto/migrate_v2_to_v3.md
70+
- Implement Сustom gRPC Sink: howto/implement_grpc_server.md
7071
- Reference:
7172
- CLI & Environment Variables: reference/cli_env.md
7273
- REST API: reference/rest.md

0 commit comments

Comments
 (0)