site_name: 🔬 pgwatch

site_description: pgwatch is a flexible PostgreSQL-specific monitoring solution

site_url: https://pgwat.ch/

use_directory_urls: false

copyright: Made by and for PostgreSQL lovers! 🐘❤️

repo_name: pgwatch by Cybertec

repo_url: https://github.com/cybertec-postgresql/pgwatch

theme:

name: material

language: en

include_search_page: false

search_index_only: true

palette:

- media: "(prefers-color-scheme: light)" # Light mode

scheme: default

toggle:

icon: material/lightbulb-outline

name: Switch to dark mode

- media: "(prefers-color-scheme: dark)" # Dark mode

scheme: slate

primary: light blue

accent: indigo

toggle:

icon: material/lightbulb

name: Switch to light mode

features:

- announce.dismiss

- search.suggest

- search.highlight

- search.share

- content.code.copy

- content.action.edit

- navigation.footer

- navigation.instant

- navigation.tracking

- navigation.tabs

- content.tabs.link

plugins:

- search

- tags

- glightbox

# - minify:

# minify_html: true

nav:

- Hello World!: index.md

- Concepts:

- Components: concept/components.md

- Installation Options: concept/installation_options.md

- Operating in Production: concept/operating_in_production.md

- Security: concept/security.md

- Web UI: concept/web_ui.md

- Metrics and Presets: concept/metrics_and_presets.md

- Advanced Features: concept/advanced_features.md

- OS Metrics via PL/Python Helpers: concept/os_helpers.md

- Observability Stack: concept/observability_stack.md

- Tutorials:

- Quickstart: tutorial/quickstart.md

- Docker Installation: tutorial/docker_installation.md

- Custom Installation: tutorial/custom_installation.md

- Preparing Databases: tutorial/preparing_databases.md

- Upgrading: tutorial/upgrading.md

- How-To Guides:

- Dashboarding and Alerting: howto/dashboarding_alerting.md

- Set Up Alerting: howto/set_up_alerting.md

- Bootstrapping the Configuration Database: howto/config_db_bootstrap.md

- Bootstrapping the Measurements Database (Sink): howto/metrics_db_bootstrap.md

- Migration from pgwatch v2: howto/migrate_v2_to_v3.md

- Implement Custom gRPC Sink: howto/implement_grpc_server.md

- Reverse Proxy Setup: howto/reverse_proxy.md

- Monitoring a Prometheus Exporter: howto/monitor_prometheus_exporter.md

- Harden a Docker Deployment: howto/harden_docker_deployment.md

- Add a Custom Metric: howto/add_custom_metric.md

- Deploy to Kubernetes: howto/deploy_to_kubernetes.md

- Configure with YAML Files: howto/yaml_configuration.md

- Monitor a Patroni Cluster: howto/monitor_patroni_cluster.md

- Enable Log Parsing: howto/enable_log_parsing.md

- Monitor PgBouncer: howto/monitor_pgbouncer.md

- Expose Metrics for Prometheus Scraping: howto/enable_prometheus_scrape.md

- Reference:

- CLI & Environment Variables: reference/cli_env.md

- REST API: reference/rest.md

- Metric Definitions: reference/metric_definitions.md

- Docker Variables: reference/docker_variables.md

- Sinks Options: reference/sinks_options.md

- Managed PostgreSQL Providers: reference/managed_postgres_support.md

- Sizing Recommendations: reference/sizing_recommendations.md

- Docker Images: reference/docker_images.md

- Listening Ports and Endpoints: reference/ports.md

- Source Types: reference/source_types.md

- Prometheus Source: reference/prometheus_source.md

- Gallery:

- Dashboards: gallery/dashboards.md

- Web UI: gallery/webui.md

- Developer:

- Contributing: developer/contributing.md

- Developer Docs: ../devel/godoc/index.html

- Code of Conduct: developer/CODE_OF_CONDUCT.md

- License: developer/LICENSE.md

markdown_extensions:

- admonition

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- pymdownx.superfences

- attr_list

extra:

version:

provider: mike

alias: true