Narcissistic Piano Mover

    This package has been deprecated

    Author message:

    This package has been moved to @microsoft/applicationinsights-web. Please install that package instead for the latest updates & features

    applicationinsights-js
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/applicationinsights-js package

    1.0.21 • Public • Published

    # (DEPRECATED) Microsoft Application Insights JavaScript SDK

    Build Status npm version

    Note: This package has been moved to @microsoft/applicationinsights-web. Please install that package instead to get the latest updates and changes to Application Insights.

    Application Insights tells you about your app's performance and usage. By adding a few lines of code to your web pages, you get data about how many users you have, which pages are most popular, how fast pages load, whether they throw exceptions, and more. And you can add code to track more detailed user activity.

    Get started

    To use this SDK, you'll need a subscription to Microsoft Azure. Application Insights has a free subscription option. In the Azure Preview Portal, create new or open an existing Application Insights resource.

    Full documentation for beta version of next SDK release is here . Please try it out and provide feedback/log any issues.

    Initializing Application Insights JS SDK script

    There are several ways to initialize Application Insights.

    Dynamic loading. JS script tag is inserted in the head of the page. This is the recommended approach as our CDN is getting frequent updates. Static loading. You are responsible for including JS script tag or bundling the script with your other scripts.
    Using initialization snippet Dynamic loading with snippet This is default approach used in a new ASP.NET application created in Visual Studio. Use this for MVC applications. Host AI JS SDK and initialize statically. Cordova applications where you would like to embed scripts into your application for faster loading is an example of when you would use this approach.
    Using module import Dynamic loading using module import. This is the recommended approach for modern modular applications. TBD

    Use JS snippet and initialize dynamically (download full Application Insights script from CDN)

    Use this method for an MVC application. Get "code to monitor my web pages" from the Quick Start page, and insert it in the head of your web pages. Application Insights script will be downloaded from CDN or you can override the script hosting location by specifying url parameter in the config.

    <script type="text/javascript">
        var appInsights=window.appInsights||function(a){
            function b(a){c[a]=function(){var b=arguments;c.queue.push(function(){c[a].apply(c,b)})}}var c={config:a},d=document,e=window;setTimeout(function(){var b=d.createElement("script");b.src=a.url||"https://az416426.vo.msecnd.net/scripts/a/ai.0.js",d.getElementsByTagName("script")[0].parentNode.appendChild(b)});try{c.cookie=d.cookie}catch(a){}c.queue=[];for(var f=["Event","Exception","Metric","PageView","Trace","Dependency"];f.length;)b("track"+f.pop());if(b("setAuthenticatedUserContext"),b("clearAuthenticatedUserContext"),b("startTrackEvent"),b("stopTrackEvent"),b("startTrackPage"),b("stopTrackPage"),b("flush"),!a.disableExceptionTracking){f="onerror",b("_"+f);var g=e[f];e[f]=function(a,b,d,e,h){var i=g&&g(a,b,d,e,h);return!0!==i&&c["_"+f](a,b,d,e,h),i}}return c
        }({
            instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
        });
    
        window.appInsights=appInsights,appInsights.queue&&0===appInsights.queue.length&&appInsights.trackPageView();
    </script>
    

    Learn more.

    Import as a module and initialize dynamically (download full Application Insights script from CDN)

    Use this method for a modern JS application that is using modules. Just like in snippet scenario the full script will be downloaded from CDN.

    • Obtain instrumentation key from your Application Insights resource

    • Install applicationinsights-js with npm npm install applicationinsights-js

    • Import and call downloadAndSetup to initialize it. You can override the script hosting location by specifying url parameter in the config

    /* import AppInsights */
    import {AppInsights} from "applicationinsights-js"
    
    /* Call downloadAndSetup to download full ApplicationInsights script from CDN and initialize it with instrumentation key */
    AppInsights.downloadAndSetup({ instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx" });
    
    /* example: track page view */
    AppInsights.trackPageView(
        "FirstPage", /* (optional) page name */
        null, /* (optional) page url if available */
        { prop1: "prop1", prop2: "prop2" }, /* (optional) dimension dictionary */
        { measurement1: 1 }, /* (optional) metric dictionary */
        123 /* page view duration in milliseconds */
    );
    
    /* example: track event */
    AppInsights.trackEvent("TestEvent", { prop1: "prop1", prop2: "prop2" }, { measurement1: 1 });
    

    Include AI JS SDK script and initialize statically

    Use this approach if you would like to host AI JS SDK script on your endpoint or bundle it with other scripts. One popular example is Cordova applications (see this blog post. After JS script has loaded, include the following snippet to initialize Application Insights:

    <!-- the snippet below assumes that JS SDK script has already loaded -->
    <script type="text/javascript" src="/pathToAIJSSDK.js"></script>
    <script type="text/javascript">
        var snippet = {
            config: {
                instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
            }
        };
        var init = new Microsoft.ApplicationInsights.Initialization(snippet);
        var appInsights = init.loadAppInsights();
        appInsights.trackPageView();
    </script>
    

    API reference

    Data on users, page views, and exceptions are provided out of the box. You can write your own code to track specific events and metrics.

    See:

    Links

    Build and run check-in tests:

    • Build

      • npm install -g grunt-cli
      • npm install
      • grunt or Ctrl+Shift+B in VisualStudio Code
      • grunt module to build the npm module
      • compiled files are dropped into a /bundle folder
    • Run check-in tests

      • grunt test to build and run tests
      • You can also open JavaScriptSDK.Tests/Selenium/Tests.html directly in your browser to debug failing tests.

    To debug tests in PhantomJS use a remote debugger: phantomjs.exe --remote-debugger-port=9000 \JavaScript\JavaScriptSDK.Tests\phantomJS.debug.js. If webkit console isn't working execute the following script in a browser's console: function isEnterKey(event) { return (event.keyCode !== 229 && event.keyIdentifier === "Enter") || event.keyCode === 13; }.

    Contributing

    We strongly welcome and encourage contributions to this project. Please read the contributor's guide located in the ApplicationInsights-Home repository. If making a large change we request that you open an issue first. We follow the Git Flow approach to branching.

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Install

    npm i applicationinsights-js

    DownloadsWeekly Downloads

    25,415

    Version

    1.0.21

    License

    MIT

    Unpacked Size

    1.09 MB

    Total Files

    10

    Last publish

    Collaborators

    • msftapplicationinsights