Skip to content

Commit c63da70

Browse files
pashagolubpashagolub
committed
[+] add folder templates for future contributions
1 parent 5a046be commit c63da70

File tree

7 files changed

+246
-0
lines changed

7 files changed

+246
-0
lines changed

‎ansible/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Ansible Playbooks for pgwatch
2+
3+
This directory contains Ansible playbooks and configuration files for automated deployment and management of pgwatch PostgreSQL monitoring infrastructure.
4+
5+
## Purpose
6+
7+
Ansible playbooks in this directory help with:
8+
9+
- Automated deployment of pgwatch monitoring components
10+
- Configuration management for PostgreSQL databases and monitoring targets
11+
- Infrastructure as code for pgwatch environments
12+
- Standardized setup procedures across different environments
13+
14+
## Usage
15+
16+
Ansible playbooks can be used to automate the installation and configuration of:
17+
18+
- pgwatch monitoring agent
19+
- Grafana dashboards
20+
- PostgreSQL configuration for monitoring
21+
- Related monitoring infrastructure components
22+
23+
## Related Components
24+
25+
This complements the main [pgwatch repository](https://github.com/cybertec-postgresql/pgwatch) by providing infrastructure automation tools for easier deployment and management.
26+
27+
For more information about pgwatch, visit the [official documentation](https://pgwat.ch/latest/).

‎docker/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Docker Configurations for pgwatch
2+
3+
This directory contains Docker-related configurations, compose files, and containerization resources for pgwatch PostgreSQL monitoring solution.
4+
5+
## Purpose
6+
7+
Docker configurations in this directory provide:
8+
9+
- Custom Docker compose setups for different deployment scenarios
10+
- Multi-container orchestration for pgwatch components
11+
- Environment-specific container configurations
12+
- Production-ready containerization examples
13+
14+
## Usage
15+
16+
Docker files can be used to deploy:
17+
18+
- pgwatch monitoring agent containers
19+
- Grafana dashboard containers
20+
- PostgreSQL configuration database containers
21+
- Complete monitoring stack deployments
22+
23+
## Related Components
24+
25+
This extends the core Docker functionality found in the main [pgwatch repository](https://github.com/cybertec-postgresql/pgwatch) with additional deployment scenarios and configurations.
26+
27+
For more information about pgwatch Docker deployment, visit the [official documentation](https://pgwat.ch/latest/).

‎grafana/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Grafana Resources for pgwatch
2+
3+
This directory contains Grafana-related resources for pgwatch PostgreSQL monitoring solution, including custom dashboards, data source configurations, and visualization components.
4+
5+
## Purpose
6+
7+
Grafana resources in this directory provide:
8+
9+
- Custom dashboard definitions for PostgreSQL monitoring
10+
- Data source configurations for different storage backends
11+
- Advanced visualization templates
12+
- Alerting rules and notification configurations
13+
14+
## Structure
15+
16+
- `postgres/` - PostgreSQL-specific Grafana dashboards and configurations
17+
- `prometheus/` - Prometheus-specific Grafana dashboards and configurations
18+
19+
## Usage
20+
21+
These resources complement the built-in Grafana dashboards provided by pgwatch with:
22+
23+
- Specialized dashboards for specific use cases
24+
- Custom metric visualizations
25+
- Advanced alerting configurations
26+
- Integration templates for different monitoring scenarios
27+
28+
## Related Components
29+
30+
This extends the core Grafana functionality found in the main [pgwatch repository](https://github.com/cybertec-postgresql/pgwatch) with additional dashboards and configurations.
31+
32+
For more information about pgwatch dashboarding, visit the [official documentation](https://pgwat.ch/latest/).

‎grafana/postgres/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# PostgreSQL-specific Grafana Dashboards
2+
3+
This directory contains Grafana dashboard configurations specifically designed for PostgreSQL monitoring within the pgwatch ecosystem.
4+
5+
## Purpose
6+
7+
PostgreSQL-specific Grafana dashboards provide:
8+
9+
- Detailed PostgreSQL performance metrics visualization
10+
- Database-specific health monitoring dashboards
11+
- Query performance analysis dashboards
12+
- Connection and transaction monitoring views
13+
14+
## Content
15+
16+
This directory may contain:
17+
18+
- JSON dashboard definitions for PostgreSQL monitoring
19+
- Custom panel configurations for PostgreSQL metrics
20+
- Templated dashboards for different PostgreSQL versions
21+
- Specialized views for PostgreSQL cluster monitoring
22+
23+
## Usage
24+
25+
These dashboards are designed to work with pgwatch's PostgreSQL metric collection and provide deep insights into:
26+
27+
- Database performance metrics
28+
- Query execution statistics
29+
- Index usage and performance
30+
- Lock and wait event analysis
31+
- Memory and disk utilization
32+
33+
## Integration
34+
35+
These dashboards integrate with pgwatch's metric collection system and are designed to work with PostgreSQL as both the monitoring target and potentially as a storage backend.
36+
37+
For more information about pgwatch PostgreSQL monitoring, visit the [official documentation](https://pgwat.ch/latest/).

‎grafana/prometheus/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Prometheus-specific Grafana Dashboards
2+
3+
This directory contains Grafana dashboard configurations specifically designed for Prometheus integration within the pgwatch ecosystem.
4+
5+
## Purpose
6+
7+
Prometheus-specific Grafana dashboards provide:
8+
9+
- Prometheus-formatted metric visualization for PostgreSQL monitoring
10+
- Time-series specific dashboard configurations
11+
- PromQL-based query templates for PostgreSQL metrics
12+
- Integration dashboards for Prometheus alerting
13+
14+
## Content
15+
16+
This directory may contain:
17+
18+
- JSON dashboard definitions optimized for Prometheus data sources
19+
- PromQL query templates for PostgreSQL metrics
20+
- Alerting rule configurations for Prometheus
21+
- Multi-target dashboard templates for Prometheus federation
22+
23+
## Usage
24+
25+
These dashboards are designed to work when pgwatch is configured to use Prometheus as a storage backend, providing:
26+
27+
- PostgreSQL metrics visualization through Prometheus
28+
- Integration with Prometheus alerting and recording rules
29+
- Multi-instance PostgreSQL monitoring dashboards
30+
- Time-series analysis optimized for Prometheus storage
31+
32+
## Integration
33+
34+
These dashboards integrate with pgwatch's Prometheus output capability and are designed to leverage Prometheus's time-series database features for PostgreSQL monitoring.
35+
36+
For more information about pgwatch Prometheus integration, visit the [official documentation](https://pgwat.ch/latest/).

‎k8s/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Kubernetes Deployments for pgwatch
2+
3+
This directory contains Kubernetes manifests, Helm charts, and deployment configurations for running pgwatch PostgreSQL monitoring solution in Kubernetes environments.
4+
5+
## Purpose
6+
7+
Kubernetes configurations in this directory provide:
8+
9+
- Production-ready Kubernetes deployment manifests
10+
- Helm charts for pgwatch components
11+
- ConfigMaps and Secrets management for monitoring configuration
12+
- Service definitions and ingress configurations
13+
14+
## Content
15+
16+
This directory may contain:
17+
18+
- Deployment manifests for pgwatch monitoring agents
19+
- Service definitions for Grafana dashboards
20+
- ConfigMap templates for PostgreSQL monitoring configuration
21+
- Helm charts for complete pgwatch stack deployment
22+
- Ingress configurations for external access
23+
- Persistent volume configurations for metric storage
24+
25+
## Usage
26+
27+
These Kubernetes resources enable deployment of pgwatch in containerized environments:
28+
29+
- Scalable pgwatch monitoring agent deployments
30+
- High-availability Grafana dashboard services
31+
- Persistent storage for monitoring metrics and configuration
32+
- Integration with Kubernetes service discovery
33+
- Resource limits and monitoring for pgwatch components
34+
35+
## Integration
36+
37+
These configurations integrate with Kubernetes native features and can leverage:
38+
39+
- Kubernetes service discovery for PostgreSQL targets
40+
- ConfigMap-based configuration management
41+
- Secret management for database credentials
42+
- Horizontal pod autoscaling for monitoring components
43+
44+
For more information about pgwatch Kubernetes deployment, visit the [official documentation](https://pgwat.ch/latest/).

‎metric/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Custom Metric Definitions for pgwatch
2+
3+
This directory contains custom metric definitions, SQL queries, and metric configuration files for extending pgwatch PostgreSQL monitoring capabilities.
4+
5+
## Purpose
6+
7+
Custom metric definitions in this directory provide:
8+
9+
- Additional PostgreSQL metric collection queries
10+
- Application-specific monitoring metrics
11+
- Custom SQL-based monitoring definitions
12+
- Extended metric sets for specialized PostgreSQL configurations
13+
14+
## Content
15+
16+
This directory may contain:
17+
18+
- SQL files with custom metric collection queries
19+
- JSON/YAML metric definition configurations
20+
- Custom metric sets for specific PostgreSQL extensions
21+
- Application-specific monitoring queries
22+
- Performance monitoring templates for specialized workloads
23+
24+
## Usage
25+
26+
These custom metrics extend pgwatch's built-in monitoring capabilities:
27+
28+
- Monitor application-specific database metrics
29+
- Collect custom performance indicators
30+
- Track business-specific database KPIs
31+
- Monitor PostgreSQL extension-specific metrics
32+
- Implement custom alerting thresholds
33+
34+
## Integration
35+
36+
Custom metrics integrate with pgwatch's metric collection system and can:
37+
38+
- Be loaded dynamically by the pgwatch monitoring agent
39+
- Extend the default metric collection intervals
40+
- Provide data for custom Grafana dashboards
41+
- Support custom alerting rules and thresholds
42+
43+
For more information about pgwatch custom metrics, visit the [official documentation](https://pgwat.ch/latest/reference/metric_definitions.html).

0 commit comments

Comments
 (0)