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

feat: signer monitoring server #4719

Merged
merged 10 commits into from May 7, 2024
Merged

feat: signer monitoring server #4719

merged 10 commits into from May 7, 2024

Conversation

hstove
Copy link
Contributor

@hstove hstove commented Apr 25, 2024

This adds an (optional) metrics/monitoring server the the stacks-signer. It's designed similarly to the node's metrics server, where the server runs optionally and behind a monitoring_prom feature flag.

There is a new signer config option, metrics_endpoint, which specifies where the server should listen.

There are a bunch of metrics that are relevant to signer operation, but I might have missed some things that would be good to add! Please let me know if you think a metric is missing or should be changed.

The available routes exposed are:

  • /metrics: prometheus metrics
  • /info: JSON about the currently running signer
  • /heartbeat: Check the connection from the signer to the node. Returns 200 or 500.
  • /: 200 ok

With these routes, my hope is that this can help with signers answering the "is this thing running correctly" question.

@hstove hstove requested review from kantai and jferrant April 25, 2024 20:12
@hstove hstove linked an issue Apr 25, 2024 that may be closed by this pull request
@hstove
Copy link
Contributor Author

hstove commented Apr 26, 2024

One thought is that it'd be good to have some timing metrics here, like roundtrip time for signer -> node RPC calls.

EDIT: added ✅

@hstove hstove requested a review from jferrant April 29, 2024 23:59
jferrant
jferrant previously approved these changes May 1, 2024
Copy link
Member

@kantai kantai left a comment

Choose a reason for hiding this comment

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

This looks good to me, just had a few comments.

Copy link
Contributor

@obycode obycode left a comment

Choose a reason for hiding this comment

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

Looks good. No additional comments outside of those Aaron already covered. Will approve once those are addressed. 👍

@hstove hstove requested a review from kantai May 6, 2024 14:08
@hstove hstove requested a review from obycode May 6, 2024 14:08
Copy link
Contributor

@obycode obycode left a comment

Choose a reason for hiding this comment

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

Thanks!

@hstove hstove added this pull request to the merge queue May 7, 2024
Merged via the queue into develop with commit 738c4c8 May 7, 2024
188 of 264 checks passed
@hstove hstove deleted the feat/signer-metrics branch May 7, 2024 16:54
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.

Nakamoto Signer[3.0] - Expose prometheus metrics from stacks-signer
5 participants