API re-design #52
Merged
API re-design #52
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
Add total time and events count. Add gc flags when supported.
This was
linked to
issues
Aug 13, 2020
Closed
Closed
Closed
Start the work on redesign doc metrics to carry state. Attach cpu metric on doc instance. Change the `data` event to `sample`. Don't pass arguments to the event. BREAKING CHANGE: the cpu metric is not exposed anymore to the event handler, but it is attached to the Doc instance. The event name is changed from `data` to `sample`.
Attach metric to Doc instance to expose its API to the user, as done with the cpu. BREAKING CHANGE: the eventLoopDelay metric is not exposed anymore to the event handler, but it is attached to the Doc instance.
Expose the metric directly from the Doc instance. BREAKING CHANGE: the metric is not exposed to the event handler anymore, but it is attached directly to the Doc instance.
Attach memory and activeHandles to Doc instance. Add config options to manually start metrics collection and ref the underlying timer.
Export types without using a namespace. BREAKING CHANGE: types are not accessible using `Doc.` notation. `DocInstance` has been renamed to `Doc` and declared as a class.
|
@acheronfail I changed many things in the types definitions, not sure if I messed them up. I removed the namespace and exported both a default factory function and the |
acheronfail
suggested changes
Aug 23, 2020
acheronfail
reviewed
Aug 23, 2020
|
@acheronfail I should have addressed your suggestions. Thank you. Could you take another look? |
Expose a `compute` method to allow the user to compute other values from the event loop delay histogram.
Rename the Doc class to Sampler. BREAKING CHANGE: the exported class is named Sampler and not Doc anymore
Align tests with the last refactor.
|
All looks good to me mate 👍 Very excited about these changes. 🚀 |
acheronfail
approved these changes
Sep 8, 2020
Align symbols names of the Sampler. Change descriptions to follow Node.js standard. See https://github.com/nodejs/node/blob/master/doc/guides/using-symbols.md
dnlup
force-pushed
the
api_redesign
branch
2 times, most recently
from
acdbee1 to
decca27
Compare
Write the readme from the ground up to reflect the API changes.
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.
To add some new features, deal with the stateful nature of the eventLoopDelay Histogram and give the user more ways to extract data from the collected metrics, I decided to re-design the whole API of the module.
TODO:
datatosample