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

Adds prometheus metrics collection and endpoint #798

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JPrevost
Copy link
Member

@JPrevost JPrevost commented Feb 26, 2024

Why are these changes being introduced:

  • The ability to understand how how timdex api is being used, including which fields are being used and whether any deprecated fields are being requested will help us have necessary information to make decisions going forward
  • A culture of assessment is part of our discovery strategic plan. Intentional, specific metric collection is an important part of assessing our platform.

How does this address that need:

  • Adds a feature flag, controlled by ENV that enables collection of a few intial metrics and exposes them for collection by prometheus servers

Document any side effects to this change:

  • the metrics endpoint is open to anyone wanting to grab metrics

Developer

  • All new ENV is documented in README
  • All new ENV has been added to Heroku Pipeline, Staging and Prod
  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • There are appropriate tests covering any new functionality
  • The documentation has been updated or is unnecessary
  • The changes have been verified
  • New dependencies are appropriate or there were no changes

Requires database migrations?

NO

Includes new or updated dependencies?

YES

Why are these changes being introduced:

* The ability to understand how how timdex api is being used, including
  which fields are being used and whether any deprecated fields are
  being requested will help us have necessary information to make
  decisions going forward
* A culture of assessment is part of our discovery strategic plan.
  Intentional, specific metric collection is an important part of
  assessing our platform.

How does this address that need:

* Adds a feature flag, controlled by ENV that enables collection of a
  few intial metrics and exposes them for collection by prometheus
  servers

Document any side effects to this change:

* the metrics endpoint is open to anyone wanting to grab metrics
@mitlib mitlib temporarily deployed to timdex-pr-798 February 26, 2024 15:42 Inactive
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.

None yet

2 participants