Skip to content

Datastore metrics optional during init, off by default #10767

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

Jump to bottom
Closed
3 tasks done
gammazero opened this issue Mar 27, 2025 · 0 comments · Fixed by #10788
Closed
3 tasks done

Datastore metrics optional during init, off by default #10767

gammazero opened this issue Mar 27, 2025 · 0 comments · Fixed by #10788
Assignees
@gammazero
Labels
kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up

Comments

@gammazero
Copy link
Contributor

Checklist

  • My issue is specific & actionable.
  • I am not suggesting a protocol enhancement.
  • I have searched on the issue tracker for my issue.

Description

When initializing a new instance, enabling datastore metrics should be optional. If not specified, the default should be to have metrics off. Metrics should be off by default as they have a minor performance impact and result in a more complex config.

  • New -metrics boolean flag to ipfs init command.
  • Default config does not configure a measure datastore for any datastore.
  • Existings configs will not be changed.

If -measure=true is specified during ipfs init then the datastore config will be as it is today, with each datastore having a parent measure type of datastore in its spec config.

If -measure=false is specified or the flag is not provided during ipfs init then each datastore in the datastore config will not have parent measure type of datastore, and instead just the datastore will be configured with no child in its spec config.
@gammazero gammazero added the kind/enhancement A net-new feature or improvement to an existing feature label Mar 27, 2025
@guillaumemichel guillaumemichel added the P1 High: Likely tackled by core team if no one steps up label Apr 8, 2025
gammazero added a commit that referenced this issue Apr 22, 2025
@gammazero
datastore: metrics optional and off by default
a4d929c 
When ipfs is initialized, the datastore metrics wrapper is not configured by default as it previously was. To enable datastore metrics during initialization, specifying the appropriate `--profile` option.

To enable datastore metrics tracking wrapper, initialize with datastore profile name + "-measure" suffix. For example:
```
ipfs init --profile flatfs-measure
```

Closes #10767
@gammazero gammazero mentioned this issue Apr 22, 2025
Merged
@gammazero gammazero self-assigned this Apr 24, 2025
gammazero added a commit that referenced this issue Apr 30, 2025
@gammazero
datastore: metrics optional and off by default
ec87fee 
When ipfs is initialized, the datastore metrics wrapper is not configured by default as it previously was. To enable datastore metrics during initialization, specifying the appropriate `--profile` option.

To enable datastore metrics tracking wrapper, initialize with datastore profile name + "-measure" suffix. For example:
```
ipfs init --profile flatfs-measure
```

Closes #10767
gammazero added a commit that referenced this issue Apr 30, 2025
@gammazero
datastore: metrics optional and off by default
c244f54 
When ipfs is initialized, the datastore metrics wrapper is not configured by default as it previously was. To enable datastore metrics during initialization, specifying the appropriate `--profile` option.

To enable datastore metrics tracking wrapper, initialize with datastore profile name + "-measure" suffix. For example:
```
ipfs init --profile flatfs-measure
```

Closes #10767
lidel added a commit that referenced this issue Apr 30, 2025
@gammazero @lidel
refactor: make datastore metrics opt-in (#10788)
b3973fa 
* datastore: metrics optional and off by default

When ipfs is initialized, the datastore metrics wrapper is not configured by default as it previously was. To enable datastore metrics during initialization, specifying the appropriate `--profile` option.

To enable datastore metrics tracking wrapper, initialize with datastore profile name + "-measure" suffix. For example:
```
ipfs init --profile flatfs-measure
```

Closes #10767

* fix sharness tests for new datastore dafaults

* Add sharness test to check metrics added by flatfs-measure profile

* Document updated metrics in changelog

* update config doc with new profiles

* docs(changelog): separate section

* initialize non-measure pebbleds with FormatMajorVersion config

* docs: fix typos, add docs link

---------

Co-authored-by: gammazero <[email protected]>
Co-authored-by: Marcin Rataj <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gammazero gammazero

Labels
kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

datastore: metrics datastore configuration optional and off by default ipfs/kubo
2 participants
@gammazero @guillaumemichel