Skip to content

Commit

Permalink
fix span tree rendering and other review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Mirko-von-Leipzig committed Feb 20, 2025
1 parent 390b730 commit bf9bb30
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ source.

### Debian package

Debian packages are available and are the fastest way to install the node on a Debian-based system. Currently only
`amd64` architecture are supported.
Debian packages are available and are the fastest way to install the node on a Debian-based system. Both `amd64` and
`arm64` packages are available.

These packages can be found under our [releases](https://github.com/0xPolygonMiden/miden-node/releases) page along with
a checksum.
Expand Down Expand Up @@ -140,8 +140,8 @@ miden-node init \
```

which will generate `miden-node.toml` and `genesis.toml` files. The latter controls the accounts that the genesis block
will be spawned with and by default includes a basic wallet account and a basic fungible faucet account. You can modify
this file to add/remove accounts as desired.
will be spawned with and by default includes a basic fungible faucet account. You can modify this file to add/remove
accounts as desired.

Next, bootstrap the chain by generating the genesis data:

Expand Down
4 changes: 3 additions & 1 deletion docs/dev/monitoring.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Monitoring

Developer level overview of how we aim to use `tracing` and `open-telemetry` to provide monitoring and telemetry for the
node.

Expand Down Expand Up @@ -86,7 +88,7 @@ A good convention to follow is creating child spans for timing information you m
operation. As an example, it may make sense to instrument a mutex locking function to visualize the contention on it. Or
separating the database file IO from the sqlite statement creation. Essentially operations which you would otherwise
consider logging the timings for should be separate spans. While you may find this changes the code you might otherwise
create, I've found this actually results in fairly good structure since it follows your business logic sense.
create, We've found this actually results in fairly good structure since it follows your business logic sense.

### Inclusions and naming conventions

Expand Down
1 change: 1 addition & 0 deletions docs/operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ This trace covers the building, proving and submission of a block.

<details>
<summary>Span tree</summary>

```sh
block_builder.build_block
┝━ block_builder.select_block
Expand Down

0 comments on commit bf9bb30

Please sign in to comment.