All notable changes to this project will be documented in this file.
Full changelog below.
- Introduced a new observability framework utilizing the
ipc-observabilitycrate.- This framework introduces events and metrics for detailed system monitoring and analysis.
- Integrates with Prometheus for real-time tracking, alerting, and visualization.
- Simplifies observability integration with ready-to-use macros, structs, and functions.
IPC now emits events during execution. These events are recorded in the Journal, and are transformed into Prometheus metrics. Observability configuration is performed via config.toml.
Refer to full observability documentation here.
| Domain | Event | Description | Metric(s) derived |
|---|---|---|---|
| Consensus | BlockProposalReceived |
Tracks block proposal reception | consensus_block_proposal_received_height (IntGauge) |
| Consensus | BlockProposalSent |
Tracks block proposal sending | consensus_block_proposal_sent_height (IntGauge) |
| Consensus | BlockProposalEvaluated |
Records the result from evaluating block proposals | consensus_block_proposal_accepted_height (IntGauge), consensus_block_proposal_rejected_height (IntGauge) |
| Consensus | BlockCommitted |
Tracks committed blocks | consensus_block_committed_height (IntGauge) |
| Execution | MsgExec |
Represents various message execution paths (Check, Apply, Estimate, Call) | exec_fvm_check_execution_time_secs (Histogram), exec_fvm_estimate_execution_time_secs (Histogram), exec_fvm_apply_execution_time_secs (Histogram), exec_fvm_call_execution_time_secs (Histogram) |
| Bottomup | CheckpointCreated |
Records checkpoint creation | bottomup_checkpoint_created_total (IntCounter), bottomup_checkpoint_created_height (IntGauge), bottomup_checkpoint_created_msgcount (IntGauge), bottomup_checkpoint_created_confignum (IntGauge) |
| Bottomup | CheckpointSigned |
Records checkpoint signatures | bottomup_checkpoint_signed_height (IntGaugeVec) |
| Bottomup | CheckpointFinalized |
Records checkpoint finalization (quorum reached) | bottomup_checkpoint_finalized_height (IntGauge) |
| Topdown | ParentRpcCalled |
Tracks parent RPC calls in the context of top-down finality | topdown_parent_rpc_call_total (IntCounterVec), topdown_parent_rpc_call_latency_secs (HistogramVec) |
| Topdown | ParentFinalityAcquired |
Records acquisition of new parent finality | topdown_parent_finality_latest_acquired_height (IntGaugeVec) |
| Topdown | ParentFinalityPeerVoteReceived |
Records peer votes for parent finality | topdown_parent_finality_voting_latest_received_height (IntGaugeVec) |
| Topdown | ParentFinalityPeerVoteSent |
Records own votes for parent finality | topdown_parent_finality_voting_latest_sent_height (IntGauge) |
| Topdown | ParentFinalityPeerQuorumReached |
Records quorum reached in parent finality voting | topdown_parent_finality_voting_quorum_height (IntGauge), topdown_parent_finality_voting_quorum_weight (IntGauge) |
| Topdown | ParentFinalityCommitted |
Tracks parent finality committed on chain | topdown_parent_finality_committed_height (IntGauge) |
| System | TracingError |
Logs tracing errors | tracing_errors (IntCounterVec) |
- (node) New observability architecture + events (#1053)
- (node) New observability bottom up tracing/metrics (#1061)
- (ethapi) Add eth cors settings (#1021)
- (node) File-based observability configuration (#1078)
- (node) Observability docs and changelog section (#1083)
- (ethapi) Make
eth_getTransactionReceiptnull for unexecuted/unknown transactions (#1006)
- (node) Observability refinements. (#1085)
- (specs) Ethereum JSON-RPC API (#913)
- Validate PR titles against conventional commits. (#1075)
Hello World! It's early days for IPC. We are starting to enact a proper versioning and changelog practices. The framework will evolve rapidly in the next quarters, and it'll do so in major architectural milestones. With high probability, backwards compatibility between these milestones will not be preserved, requiring a manual migration to upgrade from one to the next. To cite a few such expected milestones: IPC modularization, consensus pluggability, Wasm-based client kernel.
We introduce the notion of "product generations" to represent the lifetime of IPC under each of these major architectural iterations. Product generations are named alphabetically A-Z (we certainly don't expect more than 26 generations...) We've kept the naming universe deliberately broad: entities/concepts found in biological, mathematical, or computing networks.
The first product generation is called Axon!
Find more background on these choices / implications here: #1012.
This is the baseline release of the IPC framework. A variation of this release is powering the networks of Fluence and Basin. Throughout the Axon generation, we do not expect to release crates and therefore we're staying away from adopting semver, resorting instead to simple sequential revision numbers. We're aiming to cut/tag revisions and publish changelogs on a weekly basis, with some flexibility to account for work in progress landing smoothly.
Axon r01 supports these major features (not a comprehensive list):
- CometBFT/Ignite-based consensus (currently on v0.37 but with plans to upgrade to v0.38 / v1).
- Wasm- and IPLD-based Filecoin Virtual Machine as an execution layer, supporting custom built-in Wasm actors, custom syscalls, custom gas price lists, and more.
- Ethereum-compatible runtime and JSON-RPC API (quasi-Dencun level, missing MCOPY support).
- Validator membership: federated (proof of authority) and collateral-driven (basis for proof of stake).
- Configurable supply source for subnets: either inheriting the parent root coin, or adopting an ERC20-compatible token for circulating supply / gas.
- L2 subnet creation, with L3+ behind a feature flag until we harden message propagation, response paths, and fault scenarios.
- Asynchronous general message passing across the IPC hierarchy, with result and return data delivery back to the caller.
- Cross-linked security: checkpointing on the parent via the relayer, and committing parent's finality in the subnet.
- Ability to permission and restrict contract deployment in subnets.
- Upgradability: framework actors can be upgraded through contract upgrades, and subnet hard forks can be run with the UpgradeScheduler.
- Validator management through the parent network.
- Automatic chain snapshots, with ability to bootstrap from them.
- Compatibility with the BlockScount explorer and Ethereum wallets out of the box.
- ... and a lot more.
Come ask your questions or give us feedback in the #ipc channel on Filecoin Slack.