Skip to content

HTTP API: document disable_stats and enable_queue_totals #9562

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

Merged
merged 2 commits into from
Sep 28, 2023

Conversation

dcorbacho
Copy link
Contributor

@dcorbacho dcorbacho commented Sep 28, 2023

These query parameters have been present since 2019 (probably 3.8) but weren't properly documented.

Using GET /api/queues?disable_stats=true&enable_queue_totals=true is far more efficient than the standard GET /api/queues and in many cases will suffice for monitoring and operating purposes.

Related to #9437

Types of Changes

  • Bug fix (non-breaking change which fixes issue #NNNN)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause an observable behavior change in existing systems)
  • Documentation improvements (corrections, new content, etc)
  • Cosmetic change (whitespace, formatting, etc)
  • Build system and/or CI

Checklist

  • I have read the CONTRIBUTING.md document
  • I have signed the CA (see https://cla.pivotal.io/sign/rabbitmq)
  • I have added tests that prove my fix is effective or that my feature works
  • All tests pass locally with my changes
  • If relevant, I have added necessary documentation to https://github.com/rabbitmq/rabbitmq-website
  • If relevant, I have added this change to the first version(s) in release-notes that I expect to introduce it

Using GET /api/queues?disable_stats=true&enable_queue_totals=true is far more efficient than the standard GET /api/queues and in many cases will suffice for monitoring and operating purposes.
@dcorbacho dcorbacho force-pushed the http-api-doc-queue-totals branch from cb314e4 to 9d8a537 Compare September 28, 2023 07:16
@michaelklishin michaelklishin merged commit b199ce7 into main Sep 28, 2023
@michaelklishin michaelklishin deleted the http-api-doc-queue-totals branch September 28, 2023 10:00
michaelklishin added a commit that referenced this pull request Sep 28, 2023
HTTP API: document disable_stats and enable_queue_totals (backport #9562)
michaelklishin added a commit that referenced this pull request Sep 28, 2023
HTTP API: document disable_stats and enable_queue_totals (backport #9562) (backport #9566)
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