seek-datadog-custom-metrics - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

lib-es2015/AppConfig.js

@@ -0,1 +1,2 @@
+export {};
 //# sourceMappingURL=AppConfig.js.map

lib-es2015/MetricsClient.js

@@ -0,1 +1,2 @@
+export {};
 //# sourceMappingURL=MetricsClient.js.map

package.json

@@ -8,7 +8,5 @@ {
   "devDependencies": {
-    "@types/node": "14.0.12",
-    "eslint-plugin-tsdoc": "0.2.5",
-    "hot-shots": "7.5.0",
-    "semantic-release": "17.0.8",
-    "skuba": "3.5.0-beta.2"
+    "@types/node": "14.11.2",
+    "hot-shots": "7.8.0",
+    "skuba": "3.9.2"
   },
@@ -26,3 +24,3 @@ "files": [
   "peerDependencies": {
-    "hot-shots": "6.x || 7.x"
+    "hot-shots": "6.x || 7.x || 8.x"
   },
@@ -43,3 +41,3 @@ "peerDependenciesMeta": {
     "lint": "skuba lint",
-    "release": "yarn build && semantic-release --success false",
+    "release": "yarn build && skuba release",
     "test": "skuba test --coverage"
@@ -49,8 +47,9 @@ },
   "skuba": {
-    "entryPoint": null,
+    "entryPoint": "src/index.ts",
     "template": null,
-    "version": "3.5.0-beta.2"
+    "type": "package",
+    "version": "3.7.3"
   },
-  "typings": "./lib-types/index.d.ts",
-  "version": "3.0.0"
+  "types": "./lib-types/index.d.ts",
+  "version": "3.0.1"
 }

README.md

 # 🐶 Datadog Custom Metrics
 
-![GitHub Release](https://github.com/seek-oss/datadog-custom-metrics/workflows/Release/badge.svg?branch=master)
-![GitHub Validate](https://github.com/seek-oss/datadog-custom-metrics/workflows/Validate/badge.svg?branch=master)
+[![GitHub Release](https://github.com/seek-oss/datadog-custom-metrics/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/datadog-custom-metrics/actions?query=workflow%3ARelease)
+[![GitHub Validate](https://github.com/seek-oss/datadog-custom-metrics/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/datadog-custom-metrics/actions?query=workflow%3AValidate)
 [![Node.js version](https://img.shields.io/badge/node-%3E%3D%2010-brightgreen)](https://nodejs.org/en/)
@@ -9,6 +9,6 @@ [![npm package](https://img.shields.io/npm/v/seek-datadog-custom-metrics)](https://www.npmjs.com/package/seek-datadog-custom-metrics)
 
-Helpers for sending [Datadog custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) from Node.js.
+Common interface for sending [Datadog custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) from Node.js runtime environments:
 
-For containerized services this depends on [hot-shots](https://github.com/brightcove/hot-shots).
-For Lambda this uses [Datadog's CloudWatch integration](https://docs.datadoghq.com/integrations/amazon_lambda/#using-cloudwatch-logs).
+- Containers (via [hot-shots](https://github.com/brightcove/hot-shots))
+- AWS Lambda (via [Datadog's CloudWatch integration](https://docs.datadoghq.com/integrations/amazon_lambda/#using-cloudwatch-logs))
 
@@ -19,4 +19,14 @@ ```shell
 
-## Tagging Convention
+## Table of contents
 
+- [Tagging convention](#tagging-convention)
+- [API reference](#api-reference)
+  - [createStatsDClient](#createstatsdclient)
+  - [createCloudWatchClient](#createcloudwatchclient)
+  - [createNoOpClient](#createnoopclient)
+  - [createTimedSpan](#createtimedspan)
+- [Contributing](https://github.com/seek-oss/datadog-custom-metrics/blob/master/CONTRIBUTING.md)
+
+## Tagging convention
+
 All custom metrics are prefixed by `AppConfig.name`.
@@ -30,3 +40,3 @@ Two global tags are also added to every custom metric:
 
-## Usage
+## API reference
 
@@ -33,0 +43,0 @@ ### `createStatsDClient`

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33320

increased by1.59%

Dev dependency count

3

decreased by-40%

Lines of code

457

increased by0.44%

Number of lines in readme file

107

increased by10.31%

No dependency changes