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(api): Monitor server RPC errors #1203

Merged
merged 26 commits into from
Mar 4, 2024

Conversation

slowli
Copy link
Contributor

@slowli slowli commented Feb 22, 2024

What ❔

  • Introduces RPC-level metadata middleware.
  • Uses this middleware to monitor server RPC errors and report stats as metrics and logs.

Why ❔

Increased API server observability.

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.
  • Spellcheck has been run via zk spellcheck.
  • Linkcheck has been run via zk linkcheck.

Copy link
Contributor Author

@slowli slowli left a comment

Choose a reason for hiding this comment

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

This approach makes it easy to introduce new metrics for RPC calls, but I'm not sure which ones would make sense. E.g., does it make sense to track the successful response size in bytes?

@slowli slowli marked this pull request as ready for review February 23, 2024 10:44
popzxc
popzxc previously approved these changes Feb 28, 2024
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

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

Nice

popzxc
popzxc previously approved these changes Feb 29, 2024
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

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

Nice.

RomanBrodetski
RomanBrodetski previously approved these changes Mar 1, 2024
Copy link
Collaborator

@RomanBrodetski RomanBrodetski left a comment

Choose a reason for hiding this comment

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

Looks really good! I would want to discuss what adidtional metrics we can add using this approach, but am right now slammed with other things. Let's bring it up on the next tech weekly please

@slowli slowli dismissed stale reviews from RomanBrodetski and popzxc via 5109757 March 4, 2024 09:49
@slowli slowli added this pull request to the merge queue Mar 4, 2024
Merged via the queue into main with commit 60d1060 Mar 4, 2024
29 checks passed
@slowli slowli deleted the aov-pla-800-monitor-server-rpc-errors branch March 4, 2024 12:23
github-merge-queue bot pushed a commit that referenced this pull request Mar 13, 2024
🤖 I have created a release *beep* *boop*
---


##
[21.1.0](core-v21.0.0...core-v21.1.0)
(2024-03-13)


### Features

* **api:** Monitor server RPC errors
([#1203](#1203))
([60d1060](60d1060))
* block revert support for consensus component
([#1213](#1213))
([8a3a938](8a3a938))
* **db:** Add Postgres table size metrics
([#1351](#1351))
([63f3ff8](63f3ff8))
* **db:** Serialize events queue as bytes
([#1420](#1420))
([955680b](955680b))
* enabled loading yaml config for the main node
([#1344](#1344))
([0adab9e](0adab9e))
* **en:** Enable Merkle tree client on EN
([#1386](#1386))
([58576d1](58576d1))
* enhance unit test for batch tip
([#1253](#1253))
([ca7d194](ca7d194))
* Moving 1.4.x to use the circuit_api
([#1383](#1383))
([8add2d6](8add2d6))
* **node_framework:** Add timeouts for remaining tasks to avoid hang
outs ([#1354](#1354))
([8108dbd](8108dbd))
* **node-framework:** Add commitment generator layer
([#1402](#1402))
([daa029c](daa029c))
* replacing 1.3.3 test harness with circuit sequencer api
([#1382](#1382))
([a628d56](a628d56))


### Bug Fixes

* **aggregator:** correct order of processing of prove transactions
([#1333](#1333))
([7522d15](7522d15))
* **api:** Fix panics in API server if storage values cache is disabled
([#1370](#1370))
([723232b](723232b))
* **api:** SQL: use = instead of ANY where possible in events-related
queries ([#1346](#1346))
([160b4d4](160b4d4))
* **consistency_checker:** Fix consistency checker for large pubdata
([#1331](#1331))
([d162add](d162add))
* **en:** Fix pending transactions subscription
([#1342](#1342))
([a040001](a040001))
* **eth-sender:** adjust the blob tx fees taking into account the
current prices
([#1399](#1399))
([fea67fb](fea67fb))
* **gas-adjuster:** Do not unwrap in gas-adjuster
([#1400](#1400))
([269812e](269812e))
* **gas-adjuster:** Use `internal_pubdata_pricing_multiplier` for
pubdata price calculation
([#1404](#1404))
([a40c2d0](a40c2d0))


### Performance Improvements

* **db:** Add "contains" clause for get_logs
([#1384](#1384))
([e62ae32](e62ae32))
* **db:** Remove obsolete indexes
([#1376](#1376))
([0afc377](0afc377))


### Reverts

* **db:** Remove "contains" clause for get_logs
([#1384](#1384))
([#1407](#1407))
([1da53f3](1da53f3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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.

3 participants