Skip to content

feat: document metrics, disable most libp2p metrics by default #5457

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

Merged
lemmih merged 11 commits into from
Mar 26, 2025
Merged

feat: document metrics, disable most libp2p metrics by default #5457

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
53f6230
reference documentation for prometheus metrics
Mar 25, 2025
b45cf35
disable libp2p metrics unless FOREST_LIBP2P_METRICS is truthy
Mar 25, 2025
9cd062e
document the FOREST_LIBP2P_METRICS env var
Mar 25, 2025
5741866
make spellcheck happy
Mar 25, 2025
779c78e
format md docs
Mar 25, 2025
2d93435
more consistent formatting
Mar 25, 2025
507e6bb
add changelog entry
Mar 25, 2025
8852001
fix typo
Mar 26, 2025
8ac1ef4
Merge branch 'main' into lemmih/metrics-docs
Mar 26, 2025
b69f51c
rename metrics env to FOREST_LIBP2P_METRICS_ENABLED
Mar 26, 2025
d5a0e5f
strings should be quoted :)
Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
### Removed

- [#5449](https://github.com/ChainSafe/forest/pull/5449) Remove unnecessary/duplicate metrics.
- [#5457](https://github.com/ChainSafe/forest/pull/5457) Remove most prometheus
metrics starting with `libp2p_`.

### Fixed

Expand Down
1 change: 1 addition & 0 deletions docs/docs/users/reference/env_variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ process.
| `FOREST_TEST_RNG_FIXED_SEED` | non-negative integer | empty | 0 | Override RNG with a reproducible one seeded by the value. This should never be used out of test context for security. |
| `RUST_LOG` | string | empty | `debug,forest_libp2p::service=info` | Allows for log level customization. |
| `FOREST_IGNORE_DRAND` | 1 or true | empty | 1 | Ignore Drand validation. |
| `FOREST_LIBP2P_METRICS` | 1 or true | empty | 1 | Include `libp2p` metrics in Forest's Prometheus output. |
Copy link
Member

@LesnyRumcajs LesnyRumcajs Mar 26, 2025

Choose a reason for hiding this comment

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

Looking at other variables (at least newer ones), it seems the convention is to have a verb to make it more obvious,e.g., _OPT_OUT (here rather opt-in), _ENABLED etc.

Copy link
Contributor Author

@lemmih lemmih Mar 26, 2025

Choose a reason for hiding this comment

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

Added _ENABLED

| `FOREST_F3_SIDECAR_RPC_ENDPOINT` | string | 127.0.0.1:23456 | `127.0.0.1:23456` | An RPC endpoint of F3 sidecar. |
| `FOREST_F3_SIDECAR_FFI_ENABLED` | 1 or true | hard-coded per chain | 1 | Whether or not to start the F3 sidecar via FFI |
| `FOREST_F3_CONSENSUS_ENABLED` | 1 or true | hard-coded per chain | 1 | Whether or not to apply the F3 consensus to the node |
Expand Down
Loading
Loading