Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pg debug dashboard #1570

Merged
merged 2 commits into from
Jan 20, 2025
Merged

pg debug dashboard #1570

merged 2 commits into from
Jan 20, 2025

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Jan 20, 2025

  • Turn on pg_stat_statement extension for all databases
  • Add PostgreSQL metrics dashboard
  • Add postgresql_exporter for each DB
  • Add data sources for raw SQL queries

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

This pull request introduces PostgreSQL observability and updates documentation regarding the use of Blockscout for debugging EVM smart contracts. Specifically, it adds PostgreSQL exporters and dashboards to the local observability stack, providing insights into PostgreSQL databases. Additionally, it updates the Blockscout documentation to include authentication steps for ghcr images and emphasizes the use of Blockscout in ephemeral environments.

What

  • book/src/SUMMARY.md: Added a new entry for PostgreSQL under the Observability section.
  • book/src/framework/observability/blockscout.md: Updated documentation with steps for ghcr authentication and added instructions on starting Blockscout. It also highlights considerations for using Blockscout in ephemeral environments.
  • book/src/framework/observability/observability_stack.md: Included links to newly added PostgreSQL dashboards and updated the helpful links section for local setup.
  • book/src/framework/observability/postgresql.md: New file introducing PostgreSQL metrics, data sources, and dashboards with links for detailed views and queries.
  • book/src/framework/verify.md: Added a note on specifying the compiler version when verifying contracts.
  • framework/.changeset/v0.4.6.md: Describes the addition of PostgreSQL exporters and dashboards, and updates to the Blockscout documentation.
  • framework/cmd/main.go & framework/cmd/observability.go: Updated to include links to PostgreSQL dashboards in the observability command output.
  • framework/cmd/observability/compose/conf/prometheus.yml & framework/cmd/observability/compose/conf/provisioning/dashboards/pg/pg.json: Introduced configurations for Prometheus data sources and PostgreSQL dashboards.
  • framework/cmd/observability/compose/conf/provisioning/datasources/loki.yaml: Added PostgreSQL data sources for Grafana.
  • framework/cmd/observability/compose/docker-compose.yaml: Included services for PostgreSQL exporters.
  • framework/examples/myproject/go.mod & go.sum: Updated dependencies.

@skudasov skudasov merged commit aab81e4 into main Jan 20, 2025
53 checks passed
@skudasov skudasov deleted the pg-debug branch January 20, 2025 17:50
@cl-sonarqube-production
Copy link

Quality Gate failed Quality Gate failed

Failed conditions
5 New Blocker Issues (required ≤ 0)
E Security Rating on New Code (required ≥ A)

See analysis details on SonarQube

Catch issues before they fail your Quality Gate with our IDE extension SonarLint SonarLint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants