Skip to content

Commit

Permalink
Bump version to 0.10.2, clean up release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr0grog committed Oct 15, 2022
1 parent b842b55 commit deede5d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 17 deletions.
40 changes: 24 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,12 @@ npm test

## Release History

* (In development)
* Support distribution metrics. You can now send distributions to Datadog by doing:
* 0.10.2 (2022-10-14)

This release includes several new features and bugfixes!

**New Features:**
* Support for distribution metrics. You can now send distributions to Datadog by doing:

```js
const metrics = require('datadog-metrics');
Expand All @@ -293,7 +297,7 @@ npm test

(Thanks to @Mr0grog.)

* Add an `onError` option for handling asynchronous errors while flushing. You can use this to get details on an error or to send error info to another error tracking service like Sentry.io:
* Add an `onError` option for handling asynchronous errors while flushing buffered metrics. You can use this to get details on an error or to send error info to a tracking service like Sentry.io:

```js
const metrics = require('datadog-metrics');
Expand All @@ -304,14 +308,12 @@ npm test
});
```

* Expose built-in reporter classes for public use. If you need to disable the metrics library for some reason, you can now do so with:
* The built-in reporter classes are now available for you to use. If you need to disable the metrics library for some reason, you can now do so with:

```js
const metrics = require('datadog-metrics');
metrics.init({
reporter: new metrics.reporters.NullReporter((flushedMetrics) => {
// Optional callback to be notified when metrics are flushed.
}),
reporter: new metrics.reporters.NullReporter(),
});
```

Expand Down Expand Up @@ -341,18 +343,24 @@ npm test

(Thanks to @Mr0grog.)

* Add `.median` aggregation for histograms. When you log a histogram metric, it ultimately creates several metrics that track the minimum value, average value, maximum value, etc. There is now one that tracks the median value. StatsD creates the same metric from histograms, so you may find this useful if transitioning from StatsD. (Thanks to @Mr0grog.)
* Add a `.median` aggregation for histograms. When you log a histogram metric, it ultimately creates several metrics that track the minimum value, average value, maximum value, etc. There is now one that tracks the median value. StatsD creates the same metric from histograms, so you may find this useful if transitioning from StatsD. (Thanks to @Mr0grog.)

* This package no longer locks specific versions of its dependencies (instead, your package manager can choose any version that is compatible). This may help when deduplicating packages for faster installs or smaller bundles. (Thanks to @Mr0grog.)

* FIX: Don’t use `unref()` on timers in non-Node.js environments. This is a step towards browser compatibility, although we are not testing browser-based usage yet. (Thanks to @Mr0grog.)
* FIX: The `apiHost` option was broken in v0.10.0 and now works again. (Thanks to @Mr0grog, @npeters.)
* FIX: Creating a second instance of `BufferedMetricsLogger` will not longer change the credentials used by previously created `BufferedMetricsLogger` instances.
* INTERNAL: Renamed the default branch in this repo to `main`. (Thanks to @dbader.)
* INTERNAL: Use GitHub actions for continuous integration. (Thanks to @Mr0grog.)
* INTERNAL: Code style cleanup. (Thanks to @Mr0grog.)
* INTERNAL: When flushing, send each metric with its own list of tags. This helps mitigate subtle errors where a change to one metric’s tags may affect others. (Thanks to @Mr0grog.)
* [View diff](https://github.com/dbader/node-datadog-metrics/compare/v0.10.1...main)
**Bug Fixes:**

* Don’t use `unref()` on timers in non-Node.js environments. This is a step towards browser compatibility, although we are not testing browser-based usage yet. (Thanks to @Mr0grog.)
* The `apiHost` option was broken in v0.10.0 and now works again. (Thanks to @Mr0grog and @npeters.)
* Creating a second instance of `BufferedMetricsLogger` will not longer change the credentials used by previously created `BufferedMetricsLogger` instances. (Thanks to @Mr0grog.)

**Internal Updates:**

* Renamed the default branch in this repo to `main`. (Thanks to @dbader.)
* Use GitHub actions for continuous integration. (Thanks to @Mr0grog.)
* Code style cleanup. (Thanks to @Mr0grog.)
* When flushing, send each metric with its own list of tags. This helps mitigate subtle errors where a change to one metric’s tags may affect others. (Thanks to @Mr0grog.)

[View diff](https://github.com/dbader/node-datadog-metrics/compare/v0.10.1...v0.10.2)

* 0.10.1 (2022-09-11)
* FIX: bug in 0.10.0 where `@datadog/datadog-api-client` was not used correctly. (Thanks to @gquinteros93)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "datadog-metrics",
"version": "0.10.1",
"version": "0.10.2",
"description": "Buffered metrics reporting via the Datadog HTTP API",
"main": "index.js",
"repository": {
Expand Down

0 comments on commit deede5d

Please sign in to comment.