@microsoft/applicationinsights-core-js

What is @microsoft/applicationinsights-core-js?

@microsoft/applicationinsights-core-js is a core library for Application Insights, which is a part of the Azure Monitor suite. It provides the essential functionalities for collecting and sending telemetry data from your applications to Azure Monitor. This package is typically used as a base for other Application Insights SDKs and can be extended to include additional telemetry features.

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

Initialization

This code demonstrates how to initialize the Application Insights core library with a given instrumentation key. This is the first step to start collecting telemetry data.

const { ApplicationInsights } = require('@microsoft/applicationinsights-core-js');
const appInsights = new ApplicationInsights({ config: {
  instrumentationKey: 'YOUR_INSTRUMENTATION_KEY'
}});
appInsights.loadAppInsights();

Custom Events

This code shows how to track custom events. Custom events can be used to log specific actions or occurrences in your application.

appInsights.trackEvent({ name: 'myCustomEvent', properties: { customProperty: 'customValue' } });

Custom Metrics

This code demonstrates how to track custom metrics. Custom metrics can be used to log numerical data points that are important for your application.

appInsights.trackMetric({ name: 'myCustomMetric', average: 42 });

Exception Tracking

This code shows how to track exceptions. Exception tracking is useful for logging errors and understanding the issues occurring in your application.

try {
  throw new Error('Test error');
} catch (e) {
  appInsights.trackException({ exception: e });
}

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

newrelic

New Relic is a comprehensive monitoring and observability platform. It offers similar functionalities to Application Insights, such as custom event tracking, metrics, and error logging. However, New Relic provides a broader range of integrations and more advanced analytics features.

datadog

Datadog is another monitoring and analytics platform that provides similar functionalities, including custom event tracking, metrics, and error logging. Datadog is known for its extensive integrations and real-time monitoring capabilities.

sentry

Sentry is a popular error tracking and performance monitoring tool. It focuses more on error tracking and performance monitoring compared to Application Insights, which offers a broader range of telemetry data collection.

README

Important: If you are looking to add Application Insights to your website/app, please see the applicationinsights-web repository to learn how to get started.

Microsoft Application Insights JavaScript SDK - Core

Core SDK layer for next version of application insights javascript SDK.

V3.x Release Breaking changes

• Removed ES3 / IE8 Support
• Removed V1 API Backward Compatibility (Upgrading V1 -> V3)

See Breaking Changes

Build & Test:

• Install: $ npm install
• Build: $ npm run build
• Test: $ 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