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

add signer metrics api #806

Merged
merged 4 commits into from
Dec 5, 2024
Merged

add signer metrics api #806

merged 4 commits into from
Dec 5, 2024

Conversation

ryanwaits
Copy link
Collaborator

What does this PR do?

Add new Signer Metric API reference docs

Checklist

  • Add to sidebar
  • Generate reference pages

Copy link

vercel bot commented Dec 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 10:09pm

@ryanwaits ryanwaits self-assigned this Dec 5, 2024
@ryanwaits ryanwaits enabled auto-merge December 5, 2024 19:28
changed copy on the index
@max-crawford
Copy link
Contributor

I updated the copy on the overview page. One thing to add @ryanwaits

I think we should add a third card to the overview page around the Prometheus metrics endpoint because that is how devs can query behavioral data around individual signers (if I'm understanding this PR correctly).

Speaking of that endpoint, is the endpoint page's description clear enough? The copy "Get Prometheus metrics for the Signer Metrics API" and "Retrieves the Prometheus metrics signer and block proposal related data" isn't very clear to me as to what information this gets me, but maybe it makes sense to devs?

@ryanwaits
Copy link
Collaborator Author

I think we should add a third card to the overview page around the Prometheus metrics endpoint because that is how devs can query behavioral data around individual signers (if I'm understanding hirosystems/signer-metrics-api#61 correctly).

makes sense to me! let me know if this looks good

copy tweaks
Copy link
Contributor

@max-crawford max-crawford left a comment

Choose a reason for hiding this comment

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

looks great. lgtm.

@ryanwaits ryanwaits merged commit f12a6cf into main Dec 5, 2024
4 checks passed
@ryanwaits ryanwaits deleted the feat/signer-api branch December 5, 2024 22:11
@ryanwaits ryanwaits mentioned this pull request Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants