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.

Sign up for GitHub

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

Jump to bottom

feat: optionally serve Prometheus metrics #473

Merged
merged 21 commits into from
Feb 8, 2024
Merged

feat: optionally serve Prometheus metrics #473

merged 21 commits into from
Feb 8, 2024

Conversation

MicaiahReid
Copy link
Contributor

@MicaiahReid MicaiahReid commented Jan 10, 2024 •
edited
Loading

Description

To enable improved alerts on downtime for Hiro's hosted Chainhook service, we need Chainhook to provide metrics that can be ingested by Prometheus. This PR changes some how we track our metrics (that are served over the /ping endpoint of the observer) to enable Prometheus compatibility, and adds a flag to optionally start a server to supply metrics to a Prometheus client.

Example

Starting chainhook with the --prometheus-port XXXX flag now enables a service that can supply Prometheus metrics at localhost:XXXX/metrics.

If using a config file, this option can be specified via:

[monitoring]
prometheus_monitoring_port = XXXX

Chainhook will behave as usual with this flag ommitted - metrics can still be retrieved via the observer's /ping endpoint, but they will not be formatted for ingestion by a Prometheus client.

Checklist

  • All tests pass
  • Tests added in this PR (if applicable)

Fixes #474, addresses #466

@MicaiahReid MicaiahReid requested a review from lgalabru January 11, 2024 20:32
@MicaiahReid MicaiahReid requested a review from lgalabru January 12, 2024 15:37
lgalabru
lgalabru approved these changes Jan 12, 2024
View reviewed changes
Copy link
Contributor

@lgalabru lgalabru left a comment

Choose a reason for hiding this comment

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

LGTM - thanks @MicaiahReid!

@MicaiahReid MicaiahReid temporarily deployed to Development-mainnet January 12, 2024 21:29 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-testnet January 12, 2024 21:29 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-mainnet February 6, 2024 17:43 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-testnet February 6, 2024 17:43 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-mainnet February 7, 2024 15:19 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-testnet February 7, 2024 15:19 — with GitHub Actions Inactive
@CharlieC3
Copy link
Member

@MicaiahReid Would it be possible to add a prefix to each metric to ensure they're easy to find. They're mixed in with thousands of other metrics, so prefixing them with something like chainhook_<metric_name> will help anyone searching for them.

@MicaiahReid
Copy link
Contributor Author

@MicaiahReid Would it be possible to add a prefix to each metric to ensure they're easy to find. They're mixed in with thousands of other metrics, so prefixing them with something like chainhook_<metric_name> will help anyone searching for them.

@CharlieC3 Yep, done!

@MicaiahReid MicaiahReid temporarily deployed to Development-mainnet February 7, 2024 18:48 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-testnet February 7, 2024 18:48 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-mainnet February 8, 2024 15:51 — with GitHub Actions Inactive
@MicaiahReid MicaiahReid temporarily deployed to Development-testnet February 8, 2024 15:51 — with GitHub Actions Inactive
@MicaiahReid
create prometheus class to track metrics
9108340
@MicaiahReid
import monitoring module to sdk
b67d300
@MicaiahReid
remove old metrics class; use prometheus monitoring mod
d346511
@MicaiahReid
add tests for monitoring class
f5f565e
@MicaiahReid
add fields to set prometheus monitoring port
949bb70
@MicaiahReid
add server to serve prometheus metrics
b97c347
@MicaiahReid
enable server for prometheus metrics on observer startup
06503e2
@MicaiahReid
fix tests and add new
cf0e67b
@MicaiahReid
cleanup
3a0adcf
@MicaiahReid
remove unused function
50e1c05
@MicaiahReid
add monitoring options to generated chainhook config
624634a
@MicaiahReid
add tests for new monitoring config setting
70ca1a7
@MicaiahReid
fix: reverse logic of disabling http_api
fb3f556
@MicaiahReid
use better default port
44a2e23
@MicaiahReid
clean up prometheus server some
14d5053
@MicaiahReid
add back function with note
e6a5b69
@MicaiahReid
fix: remove overwrite of config file
ab82f62
@MicaiahReid
bind to 0.0.0.0 instead of 127.0.0.1 for prometheus server
47412e2
@MicaiahReid
prefix prometheus metrics with chainhook_
0581ac5
@MicaiahReid MicaiahReid merged commit 1f71ddb into develop Feb 8, 2024
4 of 6 checks passed
@MicaiahReid MicaiahReid deleted the feat/prometheus branch February 8, 2024 19:51
MicaiahReid added a commit that referenced this pull request Feb 8, 2024
@MicaiahReid
feat: optionally serve Prometheus metrics (#473)
67a38ac 
### Description

To enable improved alerts on downtime for Hiro's hosted Chainhook
service, we need Chainhook to provide metrics that can be ingested by
Prometheus. This PR changes some how we track our metrics (that are
served over the `/ping` endpoint of the observer) to enable Prometheus
compatibility, and adds a flag to optionally start a server to supply
metrics to a Prometheus client.


### Example

Starting chainhook with the `--prometheus-port XXXX` flag now enables a
service that can supply Prometheus metrics at `localhost:XXXX/metrics`.

If using a config file, this option can be specified via:
```yaml
[monitoring]
prometheus_monitoring_port = XXXX
```

Chainhook will behave as usual with this flag ommitted - metrics can
still be retrieved via the observer's `/ping` endpoint, but they will
not be formatted for ingestion by a Prometheus client.

---

### Checklist

- [X] All tests pass
- [X] Tests added in this PR (if applicable)

Fixes #474, addresses #466
github-actions bot pushed a commit that referenced this pull request Feb 8, 2024
@semantic-release-bot
chore(release): 1.3.0 [skip ci]
1c13cdd 
## [1.3.0](v1.2.1...v1.3.0) (2024-02-08)

### Features

* optionally serve Prometheus metrics ([#473](#473)) ([67a38ac](67a38ac))

### Bug Fixes

* adjust ordinal_number entry in ts client inscription transfer event, add new reveal data ([#476](#476)) ([28bf5c4](28bf5c4))
* remove early return for event evaluation ([#484](#484)) ([98f9e86](98f9e86)), closes [#469](#469)
* remove unreachable panic; return instead ([#490](#490)) ([abe0fd5](abe0fd5))
* use cli feature for `cargo chainhook-install` ([#486](#486)) ([32f4d4e](32f4d4e))
* validate predicate `start_block` and `end_block` ([#489](#489)) ([e70025b](e70025b)), closes [#477](#477) [#464](#464)
@MicaiahReid MicaiahReid mentioned this pull request Feb 12, 2024
Closed
vabanaerytk added a commit to vabanaerytk/chainhook that referenced this pull request Aug 7, 2024
@vabanaerytk @semantic-release-bot
chore(release): 1.3.0 [skip ci]
51ef2d5 
## [1.3.0](hirosystems/chainhook@v1.2.1...v1.3.0) (2024-02-08)

### Features

* optionally serve Prometheus metrics ([#473](hirosystems/chainhook#473)) ([1a3e356](hirosystems/chainhook@1a3e356))

### Bug Fixes

* adjust ordinal_number entry in ts client inscription transfer event, add new reveal data ([#476](hirosystems/chainhook#476)) ([fe7ef78](hirosystems/chainhook@fe7ef78))
* remove early return for event evaluation ([#484](hirosystems/chainhook#484)) ([d0e2f60](hirosystems/chainhook@d0e2f60)), closes [#469](hirosystems/chainhook#469)
* remove unreachable panic; return instead ([#490](hirosystems/chainhook#490)) ([c7894ac](hirosystems/chainhook@c7894ac))
* use cli feature for `cargo chainhook-install` ([#486](hirosystems/chainhook#486)) ([206cb17](hirosystems/chainhook@206cb17))
* validate predicate `start_block` and `end_block` ([#489](hirosystems/chainhook#489)) ([85f3e71](hirosystems/chainhook@85f3e71)), closes [#477](hirosystems/chainhook#477) [#464](hirosystems/chainhook#464)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lgalabru lgalabru lgalabru approved these changes

Assignees
No one assigned
Labels
None yet
Projects
DevTools
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

backwards logic on disabled field for predicate api
3 participants
@MicaiahReid @CharlieC3 @lgalabru