applicationinsights - npm Package Compare versions

Comparing version 0.12.1 to 0.12.2

package.json

@@ -5,3 +5,3 @@ {
   "bugs": "https://github.com/Microsoft/AppInsights-node.js/issues",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "description": "Microsoft Application Insights module for Node.JS",
@@ -36,4 +36,11 @@ "repository": {
   "scripts": {
+    "prepublish": "tsc --module commonjs --declaration applicationInsights.ts",
+    "test": "tsc --module commonjs Tests/TestServer.ts && node Tests/TestServer",
     "postinstall": "node install.js"
+  },
+  "devDependencies": {
+    "async": "^0.9.0",
+    "node-mocks-http": "^1.2.3",
+    "typescript": "^1.0.1"
   }
 }

README.md

 # Application Insights for Node.js
 
 [![NPM version](https://badge.fury.io/js/applicationinsights.svg)](http://badge.fury.io/js/applicationinsights)
+[![Build Status](https://travis-ci.org/lukehoban/AppInsights-node.js.svg?branch=master)](https://travis-ci.org/lukehoban/AppInsights-node.js)
 
->Node.js� is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices.
+This project provides a Node.js SDK for Application Insights. [Application Insights](http://azure.microsoft.com/en-us/services/application-insights/) is a service that allows developers to keep their application available, performing and succeeding. This node module will allow you to send telemetry of various kinds (event, trace, exception, etc.) to the Application Insights service where they can be visualized in the Azure Portal. 
 
->-- <cite>[nodejs.org](http://nodejs.org/)</cite>
 
-This project extends the Application Insights API surface to support Node.js. [Application Insights](http://azure.microsoft.com/en-us/services/application-insights/) is a service that allows developers to keep their application available, performing and succeeding. This node module will allow you to send telemetry of various kinds (event, trace, exception, etc.) to the Application Insights service where they can be visualized in the Azure Portal. 
 
 
-
-
 ## Requirements ##
@@ -26,23 +23,34 @@ **Install**
 ## Usage ##
-**Configuration**
-```javascript
-import aiModule = require("applicationInsights");
 
-var appInsights = new aiModule.NodeAppInsights({
-	instrumentationKey: "<guid>" // see "Requirements" section to get a key
-});
-```
-**Track events/metrics/traces/exceptions**
 ```javascript
-appInsights.trackTrace("example trace");
-appInsights.trackEvent("example event");
-appInsights.trackException(new Error("example error"), "handledAt");
-appInsights.trackMetric("example metric", 1);
-```
-**Track all http.Server requests**
-```javascript
-// wraps http.Server to inject request tracking
-appInsights.trackAllHttpServerRequests();
+var AppInsights = require('applicationinsights');
 
-var port = process.env.port || 0;
+// instantiate an instance of NodeAppInsights
+var appInsights = new AppInsights(
+    /* configuration can optionally be passed here instead of the environment variable, example:
+    {
+        instrumentationKey: "<guid>"
+    }
+    */
+);
+
+// must be done before creating the http server ('monkey patch' http.createServer to inject request tracking)
+// this example tracks all requests except requests for "favicon" 
+appInsights.trackAllHttpServerRequests("favicon");
+
+// log unhandled exceptions by adding a handler to process.on("uncaughtException")
+appInsights.trackAllUncaughtExceptions();
+
+// manually collect telemetry
+appInsights.trackTrace("example usage trace");
+appInsights.trackEvent("example usage event name", { custom: "properties" });
+appInsights.trackException(new Error("example usage error message"), "handledHere");
+appInsights.trackMetric("example usage metric name", 42);
+
+// start tracking server startup
+var exampleUsageServerStartEvent = "exampleUsageServerStart";
+appInsights.startTrackEvent(exampleUsageServerStartEvent);
+
+// create server
+var port = process.env.port || 1337
 var server = http.createServer(function (req, res) {
@@ -52,9 +60,8 @@ res.writeHead(200, { 'Content-Type': 'text/plain' });
 }).listen(port);
+
+// stop tracking server startup (this will send a timed telemetry event)
+server.on("listening", () => {
+    appInsights.stopTrackEvent(exampleUsageServerStartEvent);
+});
 ```
-**Track uncaught exceptions**
-```javascript
-// listens for process.on("uncaughtException", ...);
-// when an exception is thrown, calls trackException and re-throws the Error.
-appInsights.trackAllUncaughtExceptions();
-```
 
@@ -66,10 +73,5 @@
 
-* Install [Visual Studio](http://www.visualstudio.com/)
-* Install [Node.js tools for Visual Studio](http://nodejstools.codeplex.com/)
-* Install [git tools for windows](http://git-scm.com/download/win)
-* Install [Node.js](http://nodejs.org/)
-* Install test dependencies
+* Install dev dependencies
 ```
-npm install node-mocks-http
-npm install async
+npm install 
 ```
@@ -82,9 +84,4 @@ * (optional) Set an environment variable to your instrumentation key
 ```
-node Tests\TestServer.js
+npm test
 ```
-> **Note**: the startup file can also be changed to TestServer.js in the *.njsproj so that the IDE runs tests instead of the example server.
-```xml
-    <StartupFile>Tests\TestServer.js</StartupFile>
-    <!-- <StartupFile>ExampleUsage.js</StartupFile> -->
-```
 
@@ -91,0 +88,0 @@

Scripts/typings/applicationInsights/ai.d.ts

@@ -754,2 +754,2 @@ declare module Microsoft.ApplicationInsights {
     }
-}
+}

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

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 4 instances 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

230967

increased by100.95%

Number of package files

23

increased by91.67%

Lines of code

4507

increased by82.91%

Worsened metrics

Dev dependency count

3

increased byInfinity%

Number of lines in readme file

102

decreased by-2.86%

Number of low supply chain risk alerts

7

increased by600%

Number of medium supply chain risk alerts

3

increased by200%

No dependency changes