Skip to content
Branch: master
Find file History
markwolff Disable window namespace overwrite (#1185)
* fix: window namespace overwrite

* refactor: move assignment to multiple lines

* refactor: disable namespace overwrite

* docs: update release changelog

* docs: add missing changelog

* rollup: revert namespace change
Latest commit 7d60cd6 Feb 5, 2020
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src Enable support for reusing plugins in multiple instances of AppInsights Dec 19, 2019
test Enable support for reusing plugins in multiple instances of AppInsights Dec 19, 2019
.npmignore reorganize repo folders Sep 4, 2019
LICENSE reorganize repo folders Sep 4, 2019
README.md
package.json Disable window namespace overwrite (#1185) Feb 5, 2020
rollup.config.js Add additional checks and polyfil for TypeScript get translations for… Jan 31, 2020
tsconfig.json Enable and maintain compatibility for older browsers including IE8 #1075 Nov 4, 2019
tslint.json address comments Sep 16, 2019

README.md

Microsoft Application Insights JavaScript SDK - React Plugin

Build Status npm version

React Plugin for the Application Insights Javascript SDK, enables the following:

  • Tracking of router changes
  • React components usage statistics

React Plugin for the Application Insights Javascript SDK

Getting Started

Install npm package:

npm install @microsoft/applicationinsights-react-js

Basic Usage

import React from 'react';
import { ApplicationInsights } from '@microsoft/applicationinsights-web';
import { ReactPlugin, withAITracking } from '@microsoft/applicationinsights-react-js';
import { createBrowserHistory } from "history";

const browserHistory = createBrowserHistory({ basename: '' });
var reactPlugin = new ReactPlugin();
var appInsights = new ApplicationInsights({
    config: {
        instrumentationKey: 'YOUR_INSTRUMENTATION_KEY_GOES_HERE',
        extensions: [reactPlugin],
        extensionConfig: {
          [reactPlugin.identifier]: { history: browserHistory }
        }
    }
});
appInsights.loadAppInsights();

// To instrument various React components usage tracking, apply the `withAITracking` higher-order
// component function.

class MyComponent extends React.Component {
    ...
}

export default withAITracking(reactPlugin, MyComponent);

Configuration

Name Default Description
history null React router history for more information see the documentation of the react-router package.

React components usage tracking

To instrument various React components usage tracking, apply the withAITracking higher-order component function.

It will measure time from the ComponentDidMount event through the ComponentWillUnmount event. However, in order to make this more accurate, it will subtract the time in which the user was idle. In other words, React Component Engaged Time = ComponentWillUnmount timestamp - ComponentDidMount timestamp - idle time.

To see this metric in the Azure portal you need to navigate to the Application Insights resource, select "Metrics" tab and configure the empty charts to display Custom metric named "React Component Engaged Time (seconds)", select aggregation (sum, avg, etc.) of your liking and apply split by "Component Name".

image

You can also run custom queries to slice and dice AI data to generate reports and visualizations as per your requirements. In the Azure portal, navigate to the Application Insights resource, select "Analytics" from the top menu of the Overview tab and run your query.

image

Please note that it can take up to 10 minutes for new custom metric to appear in the Azure Portal.

Sample App

Azure-Samples/application-insights-react-demo.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

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.

License

MIT

You can’t perform that action at this time.