@microsoft/applicationinsights-analytics-js

What is @microsoft/applicationinsights-analytics-js?

@microsoft/applicationinsights-analytics-js is a JavaScript library that allows you to collect and analyze telemetry data from your web applications. It provides functionalities for tracking page views, custom events, exceptions, and dependencies, among other things. This helps in monitoring the performance and usage of your application.

What are @microsoft/applicationinsights-analytics-js's main functionalities?

Track Page Views

This feature allows you to track page views in your application. The code sample demonstrates how to track a page view for a page named 'HomePage'.

const appInsights = require('@microsoft/applicationinsights-analytics-js');
appInsights.trackPageView({ name: 'HomePage' });

Track Custom Events

This feature allows you to track custom events. The code sample shows how to track an event named 'ButtonClicked' with a property 'buttonName' set to 'Submit'.

const appInsights = require('@microsoft/applicationinsights-analytics-js');
appInsights.trackEvent({ name: 'ButtonClicked', properties: { buttonName: 'Submit' } });

Track Exceptions

This feature allows you to track exceptions in your application. The code sample demonstrates how to catch an exception and track it using Application Insights.

const appInsights = require('@microsoft/applicationinsights-analytics-js');
try {
  // some code that may throw an error
} catch (e) {
  appInsights.trackException({ exception: e });
}

Track Dependencies

This feature allows you to track dependencies such as API calls. The code sample shows how to track a dependency with various details like ID, name, duration, success status, and result code.

const appInsights = require('@microsoft/applicationinsights-analytics-js');
appInsights.trackDependencyData({
  id: '12345',
  name: 'GET /api/data',
  duration: 300,
  success: true,
  resultCode: 200
});

Other packages similar to @microsoft/applicationinsights-analytics-js

google-analytics

Google Analytics is a widely-used web analytics service that tracks and reports website traffic. It offers similar functionalities to @microsoft/applicationinsights-analytics-js, such as tracking page views, events, and user interactions. However, it is more focused on marketing and user behavior analytics.

mixpanel

Mixpanel is an advanced analytics platform that helps you track user interactions with web and mobile applications. It provides features for tracking events, user profiles, and funnels. Compared to @microsoft/applicationinsights-analytics-js, Mixpanel offers more advanced user segmentation and engagement tools.

segment

Segment is a customer data platform that collects, cleans, and routes your customer data to various tools for analytics, marketing, and data warehousing. It offers functionalities similar to @microsoft/applicationinsights-analytics-js but focuses more on data integration and routing to multiple destinations.

README

Microsoft Application Insights JavaScript SDK - Analytics

Web Analytics Plugin for the Application Insights Javascript SDK

Build:

npm install -g grunt-cli
npm install
npm run build --silent

Run unit tests:

npm run test

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 repositories 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 [e-mail] with any additional questions or comments.

Data Collection

As this SDK is designed to enable applications to perform data collection which is sent to the Microsoft collection endpoints the following is required to identify our privacy statement.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

License

MIT