feat: add logging crate by lpahlavi · Pull Request #13 · dfinity/sol-rpc-canister

lpahlavi · 2025-02-19T17:08:18Z

This PR adds the canlog and canlog_derive crates which wrap the ic_canister_log crate to add support for log priorities, sorting, and filtering. The main functionality is provided by the canlog::log macro and canlog::LogPriorityLevels trait. The canlog_derive crate offers a procedural macro to derive the LogPriorityLevels trait automatically for an enum.

libs/logs/src/lib.rs

ninegua · 2025-02-20T15:47:30Z

canister/src/main.rs

+            }
+
+            log.entries
+                .retain(|entry| entry.timestamp >= max_skip_timestamp);


Understanding question: does it mean if there are too many entries to fit a single response, one can only query later entries by setting a starting time (which hopefully will fit in a single response), but not earlier entries?

IIUC yes. I re-used the logic from the EVM RPC canister here, since the idea is to extract the shared logic to a single crate that can then be used by the EVM and SOL RPC canisters. Do you think there would be a better way to do it here? I guess the most foolproof way would be to implement some sort of paging, although this would probably be better done in another PR. WDYT?

Sure, a separate PR for proper paging sounds good. Thanks!

lpahlavi

@ninegua Thanks a lot for your review! I've answered your questions and added one open question for you.

lpahlavi · 2025-02-21T09:20:03Z

canister/src/main.rs

+            }
+
+            log.entries
+                .retain(|entry| entry.timestamp >= max_skip_timestamp);


IIUC yes. I re-used the logic from the EVM RPC canister here, since the idea is to extract the shared logic to a single crate that can then be used by the EVM and SOL RPC canisters. Do you think there would be a better way to do it here? I guess the most foolproof way would be to implement some sort of paging, although this would probably be better done in another PR. WDYT?

libs/logs/src/lib.rs

gregorydemay

I made a quick first pass, some understanding questions.

Cargo.toml

libs/logs/Cargo.toml

lpahlavi · 2025-02-26T15:21:38Z

@ninegua @gregorydemay Thanks a lot for your reviews! I've pushed a new version of the code where the LogPriorityLevels trait is derived through a procedural macro. This is still a work in progress, but le me know if you have any first thoughts!

gregorydemay

Thanks a lot @lpahlavi for starting this effort! The code already looks very good to me, I have some minor comments/understanding questions.

Cargo.toml

gregorydemay · 2025-02-26T16:41:45Z

canister/Cargo.toml

+strum = { workspace = true }
 url = { workspace = true }
 zeroize = { workspace = true }
+paste = "1.0.15"


I would not expect the consumer of the library to need paste.

Ah yes, that's a mistake, thanks!

canlog/Cargo.toml

canister/src/main.rs

canister/src/http_types/mod.rs

canlog_derive/src/lib.rs

canister/Cargo.toml

integration_tests/tests/tests.rs

gregorydemay · 2025-02-27T09:27:54Z

libs/client/src/lib.rs

+    /// Retrieve canlog from the SOL RPC canister from the HTTP endpoint.
+    pub async fn retrieve_logs(&self, priority: &str) -> Vec<LogEntry<Priority>> {
+        let request = HttpRequest {
+            method: "".to_string(),


shouldn't it be POST?

Good point. I actually wonder why this didn't cause a problem, I guess there is a default method defined somewhere.

ninegua

Thanks for make the changes and the macro looks rather nice!

lpahlavi

Thanks a lot for the reviews @gregorydemay and @ninegua !

@gregorydemay I've addressed your feedback, LMK what you think!

Cargo.toml

canister/Cargo.toml

lpahlavi · 2025-02-27T10:53:07Z

canister/Cargo.toml

+strum = { workspace = true }
 url = { workspace = true }
 zeroize = { workspace = true }
+paste = "1.0.15"


Ah yes, that's a mistake, thanks!

canister/src/http_types/mod.rs

canlog/Cargo.toml

canlog_derive/Cargo.toml

canlog_derive/src/lib.rs

integration_tests/tests/tests.rs

rust-toolchain.toml

gregorydemay

Thanks @lpahlavi for the changes, this looks very good! I just have 2/3 small comments left.

canister/src/main.rs

canister/src/http_types/mod.rs

integration_tests/tests/tests.rs

canlog/LICENSE

canlog_derive/Cargo.toml

canlog_derive/src/lib.rs

canister/Cargo.toml

libs/client/src/lib.rs

gregorydemay

Thanks a lot @lpahlavi for making the logs re-usable!

## 🤖 New release * `sol_rpc_types`: 0.1.0 * `sol_rpc_canister`: 0.1.0 * `sol_rpc_client`: 0.1.0 <details><summary>Changelog</summary> ## `sol_rpc_types` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add Rustdoc for types related to `getTransaction` ([#71](#71)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add doc build stage to CI ([#19](#19)) - Add support for override providers ([#12](#12)) ### Changed - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Default commitment level for `SolRpcClient` ([#77](#77)) - Support method `getBalance` ([#74](#74)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use SOL RPC canister in `basic_solana` example ([#69](#69)) - Add basic README instructions ([#63](#63)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Basic Solana wallet example ([#1](#1)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Correct Solana cluster for dRPC and Helius providers ([#47](#47))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> ## `sol_rpc_canister` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> ## `sol_rpc_client` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) ### Changed - Release pipeline ([#4](#4)) - Default commitment level for `SolRpcClient` ([#77](#77)) - Support method `getBalance` ([#74](#74)) - Use SOL RPC canister in `basic_solana` example ([#69](#69)) - Rust documentation tests for the `SolRpcClient` ([#65](#65)) - Add basic README instructions ([#63](#63)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Streamline providers ([#32](#32)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Forward calls through wallet canister ([#40](#40)) - E2e test with Solana test validator ([#20](#20))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Logs at level `TraceHttp` where not added to the canister response when queried via the HTTP endpoint `/logs` (was probably forgotten in #13).

## 🤖 New release * `sol_rpc_canister`: 0.2.0 <details><summary>Changelog</summary> <blockquote> ## [0.2.0] - 2025-05-27 ### Added - Add client method to sign a transaction ([#113](#113)) - Add Chainstack RPC provider ([#118](#118)) - Add support for `getSignaturesForAddress` ([#106](#106)) - Add support for `getSignatureStatuses` RPC method ([#96](#96)) - Add support for `getTokenAccountBalance` RPC method ([#90](#90)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Bump version to 0.2 - Candid NonZeroU8 ([#108](#108)) - Add `RoundingError` to `sol_rpc_types` ([#105](#105)) - Use secure primitive types for `Pubkey`, `Signature` and `Hash` ([#98](#98)) - Add support for `getRecentPrioritizationFees` ([#92](#92)) - Simplify API keys provisioning script ([#89](#89)) - Release v0.1.0 ([#88](#88)) - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Missing `TraceHttp` logs ([#129](#129)) - End-to-end tests for `sendTransaction` ([#104](#104)) - Unit test for `getRecentPrioritizationFees` parameters serialization ([#107](#107)) - Integration test for `verifyApiKey` ([#82](#82)) - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8)) ### Removed - Remove default/non-default providers ([#122](#122)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

## 🤖 New release * `sol_rpc_canister`: 1.0.0 <details><summary>Changelog</summary> <blockquote> ## [1.0.0] - 2025-06-12 ### Added - Add support for `transactionDetails=accounts` ([#139](#139)) - Add support for `rewards` parameter for `getBlock` ([#135](#135)) - Add helper methods for request builders ([#136](#136)) - Add client method to sign a transaction ([#113](#113)) - Add Chainstack RPC provider ([#118](#118)) - Add support for `getSignaturesForAddress` ([#106](#106)) - Add support for `getSignatureStatuses` RPC method ([#96](#96)) - Add support for `getTokenAccountBalance` RPC method ([#90](#90)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Bump to 1.0.0 - Inline request parameters `is_default_config` methods ([#138](#138)) - Release v0.2.0 ([#131](#131)) - Bump version and use a release notes template ([#130](#130)) - Candid NonZeroU8 ([#108](#108)) - Add `RoundingError` to `sol_rpc_types` ([#105](#105)) - Use secure primitive types for `Pubkey`, `Signature` and `Hash` ([#98](#98)) - Add support for `getRecentPrioritizationFees` ([#92](#92)) - Simplify API keys provisioning script ([#89](#89)) - Release v0.1.0 ([#88](#88)) - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Missing `TraceHttp` logs ([#129](#129)) - End-to-end tests for `sendTransaction` ([#104](#104)) - Unit test for `getRecentPrioritizationFees` parameters serialization ([#107](#107)) - Integration test for `verifyApiKey` ([#82](#82)) - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8)) ### Removed - Remove default/non-default providers ([#122](#122)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>

XC-286: Add logging functionality

e591e08

lpahlavi marked this pull request as ready for review February 19, 2025 18:13

lpahlavi requested a review from a team as a code owner February 19, 2025 18:13

lpahlavi and others added 10 commits February 20, 2025 11:18

XC-286: Move logging functionality to separate crate

0a05f38

XC-286: Move regex types back to rpc_client

5421637

XC-286: Clippy

6849a86

XC-286: Remove unused constant

634fa26

XC-286: Clippy

3db90e4

Merge branch 'main' into lpahlavi/XC-286-logging

ea8701b

XC-286: Declare log buffers within macro

ff747bd

XC-286: Clippy

dcffe42

XC-286: Add some documentation

d35a21b

XC-286: Add some more documentation

cd15e03

ninegua approved these changes Feb 20, 2025

View reviewed changes

lpahlavi commented Feb 21, 2025

View reviewed changes

gregorydemay reviewed Feb 24, 2025

View reviewed changes

Cargo.toml Show resolved Hide resolved

libs/logs/Cargo.toml Outdated Show resolved Hide resolved

canlog and canlog_derive

4db276e

lpahlavi changed the title ~~feat: Add logging functionality~~ feat: add logging crate Feb 26, 2025

gregorydemay reviewed Feb 27, 2025

View reviewed changes

ninegua approved these changes Feb 27, 2025

View reviewed changes

address review feedback

4fb3226

lpahlavi commented Feb 27, 2025

View reviewed changes

remove unnecessary integration test dependencies

f364b53

gregorydemay reviewed Feb 28, 2025

View reviewed changes

lpahlavi added 4 commits February 28, 2025 10:39

Fix logs endpoint name

0c37229

Fix broken LICENSE symlinks

c0f08a6

Move retrieve log method to integration test crate

d7fcdf2

Merge branch 'main' into lpahlavi/XC-286-logging

b047987

gregorydemay approved these changes Feb 28, 2025

View reviewed changes

lpahlavi added 4 commits February 28, 2025 11:19

Clippy

e7d40aa

Fix documentation errors

7c40901

Removed unused import

82a67fe

Add #[doc(inline)]

d2f839d

lpahlavi merged commit bde5f88 into main Feb 28, 2025
6 checks passed

lpahlavi deleted the lpahlavi/XC-286-logging branch February 28, 2025 11:45

This was referenced Apr 28, 2025

chore: release v0.1.0 #83

Closed

chore: release v0.1.0 #88

Merged

gregorydemay mentioned this pull request May 27, 2025

fix: missing TraceHttp logs #129

Merged

gregorydemay added a commit that referenced this pull request May 27, 2025

fix: missing TraceHttp logs (#129)

c5f5629

Logs at level `TraceHttp` where not added to the canister response when queried via the HTTP endpoint `/logs` (was probably forgotten in #13).

github-actions bot mentioned this pull request May 27, 2025

chore: release v0.2.0 #131

Merged

github-actions bot mentioned this pull request Jun 12, 2025

chore: release v1.0.0 #146

Merged

github-actions bot mentioned this pull request Jul 31, 2025

chore: release #189

Closed

Conversation

lpahlavi commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lpahlavi commented Feb 26, 2025

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ninegua left a comment

Choose a reason for hiding this comment

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

lpahlavi commented Feb 19, 2025 •

edited

Loading