@microsoft/applicationinsights-web-snippet

Microsoft Application Insights JavaScript SDK - Web Snippet

Web Snippet for the Application Insights Javascript SDK

This project exists to publish latest Application Insights Javascript Web Snippet.

Basic Usage

Add the Application Insights Web Snippet to your app's dependencies and package.json.

npm i @microsoft/applicationinsights-web-snippet

Pass in Key via Function (available since v1.1.0)

Import the helper function from the package to easily get the snippet

import { getSdkLoaderScript } from "@microsoft/applicationinsights-web-snippet";

Configure the snippet with your connectionString or other customerized field:

let config = {connectionString: "InstrumentationKey=xxx", name: "myAppInsights"}; 
// or let config = {instrumentationKey: key, sri: true};
let theSnippet = getSdkLoaderScript(config);

Multiple Snippet Run Simutinously (available since v1.2.0)

Configure two snippets with different name.

let firstConfig = {connectionString: "InstrumentationKey=xxx", name: "firstAppInsights"}; 
let firstSnippet = getSdkLoaderScript(firstConfig);
let secondConfig = {connectionString: "InstrumentationKey=xxx", name: "secondAppInsights"}; 
let secondSnippet = getSdkLoaderScript(secondConfig);

Snippet Run With Integrity Check and Minified Loading Time (available since v1.2.0)

Configure the snippet with sri enabled.

let config = {connectionString: "InstrumentationKey=xxx", sri: true};

More details on web snippet, see Web Snippet.

Trusted Types Support (available since v1.2.2)

For restrictions like require-trusted-types-for 'script', check url policy check For restrictions like script-src 'self' ..., check add nounce when inject script

Build

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

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