Skip to content

[skip-ci] docs: Add comprehensive Prometheus metrics reference#5424

Open
wazir-ahmed wants to merge 1 commit intosysown:feature/modern-docsfrom
wazir-ahmed:doc-prometheus-metric
Open

[skip-ci] docs: Add comprehensive Prometheus metrics reference#5424
wazir-ahmed wants to merge 1 commit intosysown:feature/modern-docsfrom
wazir-ahmed:doc-prometheus-metric

Conversation

@wazir-ahmed
Copy link
Member

  • Add a complete Prometheus metrics catalog documenting all metrics exposed by ProxySQL, organized by functional area with support matrix for MySQL and PostgreSQL protocols (docs/references/prometheus_metrics.md)

  • Also reorganize global variable references into a dedicated references section for improved discoverability.

- Add a complete Prometheus metrics catalog documenting all metrics exposed
  by ProxySQL, organized by functional area with support matrix for MySQL
  and PostgreSQL protocols.

- Also reorganize global variable references into a dedicated references
  section for improved discoverability.

Signed-off-by: Wazir Ahmed <wazir@proxysql.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 26, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@wazir-ahmed wazir-ahmed changed the title docs: add comprehensive Prometheus metrics reference docs: Add comprehensive Prometheus metrics reference Feb 26, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @wazir-ahmed, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation by introducing a detailed reference for all Prometheus metrics exposed by ProxySQL, categorized by functional area and indicating support for MySQL and PostgreSQL protocols. Concurrently, it undertakes a major reorganization of existing global variable documentation, moving it into a new, centralized 'references' section to improve overall structure and user navigation.

Highlights

  • New Prometheus Metrics Reference: A comprehensive catalog of all Prometheus metrics exposed by ProxySQL has been added, organized by functional area and detailing support for MySQL and PostgreSQL protocols.
  • Documentation Reorganization: All global variable documentation has been moved into a new, dedicated 'references' directory to centralize reference materials and improve discoverability.
  • Link Updates: Internal links across the documentation, including navigation and content links, have been updated to reflect the new 'references' directory structure.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/features/sqlite3_server.md
    • Updated internal link to SQLite3 server variables.
  • docs/genai/mcp_endpoints.md
    • Updated internal link to MCP variables.
  • docs/genai/mcp_integration.md
    • Updated multiple internal links to MCP variables.
  • docs/genai/mcp_server.md
    • Updated internal link to MCP variables.
  • docs/genai/rag_overview.md
    • Updated internal link to MCP variables.
  • docs/global_variables/admin_variables.md
    • Renamed to docs/references/admin_variables.md.
  • docs/global_variables/global_variables.md
    • Renamed to docs/references/global_variables.md.
  • docs/global_variables/mcp_variables.md
    • Renamed to docs/references/mcp_variables.md.
  • docs/global_variables/mysql_monitor_variables.md
    • Renamed to docs/references/mysql_monitor_variables.md.
  • docs/global_variables/mysql_variables.md
    • Renamed to docs/references/mysql_variables.md.
  • docs/global_variables/pgsql_monitor_variables.md
    • Renamed to docs/references/pgsql_monitor_variables.md.
  • docs/global_variables/pgsql_variables.md
    • Renamed to docs/references/pgsql_variables.md.
  • docs/global_variables/quick-reference.md
    • Removed the quick reference for global variables.
  • docs/global_variables/sqliteserver_variables.md
    • Renamed to docs/references/sqliteserver_variables.md.
  • docs/main_runtime/configuration_tables.md
    • Updated internal links to admin and global variables.
  • docs/prometheus_metrics/prometheus_metrics.md
    • Added a new introductory line linking to the comprehensive Prometheus metrics reference.
  • docs/references/prometheus_metrics.md
    • Added a new file detailing all Prometheus metrics.
  • docusaurus.config.ts
    • Updated the navigation link for the global variables reference.
  • sidebars.ts
    • Updated sidebar entries to reflect the new 'references' directory structure and added the new Prometheus metrics reference.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@sonarqubecloud
Copy link

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive reference for Prometheus metrics and reorganizes the documentation by moving global variable references into a dedicated references section. These changes significantly improve the structure and discoverability of the documentation. The new metrics reference is detailed and a valuable addition. My review includes a few suggestions to correct minor inconsistencies and potential typos in the new metrics documentation to further enhance its clarity and accuracy.

@renecannao
Copy link
Contributor

@wazir-ahmed : skip-ci ....

@wazir-ahmed wazir-ahmed changed the title docs: Add comprehensive Prometheus metrics reference [skip-ci] docs: Add comprehensive Prometheus metrics reference Feb 26, 2026
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