feat!: configure metrics implementation as a module instead of shipping a built-in version #1471
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Instead of a built-in metrics object, allow the user to pass the
metrics collection method of their choice.
Currenltly there's a `@libp2p/prometheus-metrics` implementation,
there may be others in the future.
Before:
```js
import { createLibp2p } from 'libp2p'
const node = createLibp2p({
metrics: {
enabled: true
}
})
```
After:
```js
import { createLibp2p } from 'libp2p'
import { prometheusMetrics } from '@libp2p/prometheus-metrics'
const node = createLibp2p({
metrics: prometheusMetrics()
})
```
BREAKING CHANGE: the libp2p opts have changed to accept a metrics object factory function instead of a config object
Removes the built in metrics object in favour of accepting a factory that returns an object that implements the `Metrics` interface. BREAKING CHANGE: node config now takes a `Metrics` factory instead of metrics configuration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of a built-in metrics object, allow the user to pass the metrics collection method of their choice.
Currenltly there's a
@libp2p/prometheus-metricsimplementation, there may be others in the future.Before:
After:
BREAKING CHANGE: the libp2p opts have changed to accept a metrics object factory function instead of a config object