|
|
|
|
@ -39,8 +39,8 @@ See the [beta](https://github.com/Microsoft/ApplicationInsights-JS/tree/beta) fo
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
1. Create an Application Insights resource in Azure by following [these instructions](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-javascript?toc=/azure/azure-monitor/toc.json).
|
|
|
|
|
2. Grab the _Instrumentation Key_ (aka "ikey") from the resource you created in
|
|
|
|
|
step 1. Later, you'll add it to the `instrumentationKey` setting of the Application Insights JavaScript SDK.
|
|
|
|
|
2. Grab the _Connection String_ from the resource you created in
|
|
|
|
|
step 1. Later, you'll add it to the `connectionString` setting of the Application Insights JavaScript SDK.
|
|
|
|
|
3. Add Application Insights to your app. **There are 2 ways to do this.**
|
|
|
|
|
- Install via NPM. Then, [set up an instance of Application Insights in your app.](#npm-setup-ignore-if-using-snippet-setup)
|
|
|
|
|
> *Note:* **Typings are included with this package**, so you do **not** need to install a separate typings package.
|
|
|
|
|
@ -59,7 +59,7 @@ See the [beta](https://github.com/Microsoft/ApplicationInsights-JS/tree/beta) fo
|
|
|
|
|
import { ApplicationInsights } from '@microsoft/applicationinsights-web'
|
|
|
|
|
|
|
|
|
|
const appInsights = new ApplicationInsights({ config: {
|
|
|
|
|
instrumentationKey: 'YOUR_INSTRUMENTATION_KEY_GOES_HERE'
|
|
|
|
|
connectionString: 'YOUR_CONNECTION_STRING_GOES_HERE'
|
|
|
|
|
/* ...Other Configuration Options... */
|
|
|
|
|
} });
|
|
|
|
|
appInsights.loadAppInsights();
|
|
|
|
|
@ -72,7 +72,7 @@ If your app does not use NPM, you can directly instrument your webpages with App
|
|
|
|
|
|
|
|
|
|
```html
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
!function(T,l,y){var S=T.location,k="script",D="instrumentationKey",C="ingestionendpoint",I="disableExceptionTracking",E="ai.device.",b="toLowerCase",w="crossOrigin",N="POST",e="appInsightsSDK",t=y.name||"appInsights";(y.name||T[e])&&(T[e]=t);var n=T[t]||function(d){var g=!1,f=!1,m={initialize:!0,queue:[],sv:"5",version:2,config:d};function v(e,t){var n={},a="Browser";return n[E+"id"]=a[b](),n[E+"type"]=a,n["ai.operation.name"]=S&&S.pathname||"_unknown_",n["ai.internal.sdkVersion"]="javascript:snippet_"+(m.sv||m.version),{time:function(){var e=new Date;function t(e){var t=""+e;return 1===t.length&&(t="0"+t),t}return e.getUTCFullYear()+"-"+t(1+e.getUTCMonth())+"-"+t(e.getUTCDate())+"T"+t(e.getUTCHours())+":"+t(e.getUTCMinutes())+":"+t(e.getUTCSeconds())+"."+((e.getUTCMilliseconds()/1e3).toFixed(3)+"").slice(2,5)+"Z"}(),iKey:e,name:"Microsoft.ApplicationInsights."+e.replace(/-/g,"")+"."+t,sampleRate:100,tags:n,data:{baseData:{ver:2}}}}var h=d.url||y.src;if(h){function a(e){var t,n,a,i,r,o,s,c,u,p,l;g=!0,m.queue=[],f||(f=!0,t=h,s=function(){var e={},t=d.connectionString;if(t)for(var n=t.split(";"),a=0;a<n.length;a++){var i=n[a].split("=");2===i.length&&(e[i[0][b]()]=i[1])}if(!e[C]){var r=e.endpointsuffix,o=r?e.location:null;e[C]="https://"+(o?o+".":"")+"dc."+(r||"services.visualstudio.com")}return e}(),c=s[D]||d[D]||"",u=s[C],p=u?u+"/v2/track":d.endpointUrl,(l=[]).push((n="SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details)",a=t,i=p,(o=(r=v(c,"Exception")).data).baseType="ExceptionData",o.baseData.exceptions=[{typeName:"SDKLoadFailed",message:n.replace(/\./g,"-"),hasFullStack:!1,stack:n+"\nSnippet failed to load ["+a+"] -- Telemetry is disabled\nHelp Link: https://go.microsoft.com/fwlink/?linkid=2128109\nHost: "+(S&&S.pathname||"_unknown_")+"\nEndpoint: "+i,parsedStack:[]}],r)),l.push(function(e,t,n,a){var i=v(c,"Message"),r=i.data;r.baseType="MessageData";var o=r.baseData;return o.message='AI (Internal): 99 message:"'+("SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details) ("+n+")").replace(/\"/g,"")+'"',o.properties={endpoint:a},i}(0,0,t,p)),function(e,t){if(JSON){var n=T.fetch;if(n&&!y.useXhr)n(t,{method:N,body:JSON.stringify(e),mode:"cors"});else if(XMLHttpRequest){var a=new XMLHttpRequest;a.open(N,t),a.setRequestHeader("Content-type","application/json"),a.send(JSON.stringify(e))}}}(l,p))}function i(e,t){f||setTimeout(function(){!t&&m.core||a()},500)}var e=function(){var n=l.createElement(k);n.src=h;var e=y[w];return!e&&""!==e||"undefined"==n[w]||(n[w]=e),n.onload=i,n.onerror=a,n.onreadystatechange=function(e,t){"loaded"!==n.readyState&&"complete"!==n.readyState||i(0,t)},n}();y.ld<0?l.getElementsByTagName("head")[0].appendChild(e):setTimeout(function(){l.getElementsByTagName(k)[0].parentNode.appendChild(e)},y.ld||0)}try{m.cookie=l.cookie}catch(p){}function t(e){for(;e.length;)!function(t){m[t]=function(){var e=arguments;g||m.queue.push(function(){m[t].apply(m,e)})}}(e.pop())}var n="track",r="TrackPage",o="TrackEvent";t([n+"Event",n+"PageView",n+"Exception",n+"Trace",n+"DependencyData",n+"Metric",n+"PageViewPerformance","start"+r,"stop"+r,"start"+o,"stop"+o,"addTelemetryInitializer","setAuthenticatedUserContext","clearAuthenticatedUserContext","flush"]),m.SeverityLevel={Verbose:0,Information:1,Warning:2,Error:3,Critical:4};var s=(d.extensionConfig||{}).ApplicationInsightsAnalytics||{};if(!0!==d[I]&&!0!==s[I]){var c="onerror";t(["_"+c]);var u=T[c];T[c]=function(e,t,n,a,i){var r=u&&u(e,t,n,a,i);return!0!==r&&m["_"+c]({message:e,url:t,lineNumber:n,columnNumber:a,error:i}),r},d.autoExceptionInstrumented=!0}return m}(y.cfg);function a(){y.onInit&&y.onInit(n)}(T[t]=n).queue&&0===n.queue.length?(n.queue.push(a),n.trackPageView({})):a()}(window,document,{
|
|
|
|
|
!function(T,l,y){var S=T.location,k="script",D="connectionString",C="ingestionendpoint",I="disableExceptionTracking",E="ai.device.",b="toLowerCase",w="crossOrigin",N="POST",e="appInsightsSDK",t=y.name||"appInsights";(y.name||T[e])&&(T[e]=t);var n=T[t]||function(d){var g=!1,f=!1,m={initialize:!0,queue:[],sv:"5",version:2,config:d};function v(e,t){var n={},a="Browser";return n[E+"id"]=a[b](),n[E+"type"]=a,n["ai.operation.name"]=S&&S.pathname||"_unknown_",n["ai.internal.sdkVersion"]="javascript:snippet_"+(m.sv||m.version),{time:function(){var e=new Date;function t(e){var t=""+e;return 1===t.length&&(t="0"+t),t}return e.getUTCFullYear()+"-"+t(1+e.getUTCMonth())+"-"+t(e.getUTCDate())+"T"+t(e.getUTCHours())+":"+t(e.getUTCMinutes())+":"+t(e.getUTCSeconds())+"."+((e.getUTCMilliseconds()/1e3).toFixed(3)+"").slice(2,5)+"Z"}(),iKey:e,name:"Microsoft.ApplicationInsights."+e.replace(/-/g,"")+"."+t,sampleRate:100,tags:n,data:{baseData:{ver:2}}}}var h=d.url||y.src;if(h){function a(e){var t,n,a,i,r,o,s,c,u,p,l;g=!0,m.queue=[],f||(f=!0,t=h,s=function(){var e={},t=d.connectionString;if(t)for(var n=t.split(";"),a=0;a<n.length;a++){var i=n[a].split("=");2===i.length&&(e[i[0][b]()]=i[1])}if(!e[C]){var r=e.endpointsuffix,o=r?e.location:null;e[C]="https://"+(o?o+".":"")+"dc."+(r||"services.visualstudio.com")}return e}(),c=s[D]||d[D]||"",u=s[C],p=u?u+"/v2/track":d.endpointUrl,(l=[]).push((n="SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details)",a=t,i=p,(o=(r=v(c,"Exception")).data).baseType="ExceptionData",o.baseData.exceptions=[{typeName:"SDKLoadFailed",message:n.replace(/\./g,"-"),hasFullStack:!1,stack:n+"\nSnippet failed to load ["+a+"] -- Telemetry is disabled\nHelp Link: https://go.microsoft.com/fwlink/?linkid=2128109\nHost: "+(S&&S.pathname||"_unknown_")+"\nEndpoint: "+i,parsedStack:[]}],r)),l.push(function(e,t,n,a){var i=v(c,"Message"),r=i.data;r.baseType="MessageData";var o=r.baseData;return o.message='AI (Internal): 99 message:"'+("SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details) ("+n+")").replace(/\"/g,"")+'"',o.properties={endpoint:a},i}(0,0,t,p)),function(e,t){if(JSON){var n=T.fetch;if(n&&!y.useXhr)n(t,{method:N,body:JSON.stringify(e),mode:"cors"});else if(XMLHttpRequest){var a=new XMLHttpRequest;a.open(N,t),a.setRequestHeader("Content-type","application/json"),a.send(JSON.stringify(e))}}}(l,p))}function i(e,t){f||setTimeout(function(){!t&&m.core||a()},500)}var e=function(){var n=l.createElement(k);n.src=h;var e=y[w];return!e&&""!==e||"undefined"==n[w]||(n[w]=e),n.onload=i,n.onerror=a,n.onreadystatechange=function(e,t){"loaded"!==n.readyState&&"complete"!==n.readyState||i(0,t)},n}();y.ld<0?l.getElementsByTagName("head")[0].appendChild(e):setTimeout(function(){l.getElementsByTagName(k)[0].parentNode.appendChild(e)},y.ld||0)}try{m.cookie=l.cookie}catch(p){}function t(e){for(;e.length;)!function(t){m[t]=function(){var e=arguments;g||m.queue.push(function(){m[t].apply(m,e)})}}(e.pop())}var n="track",r="TrackPage",o="TrackEvent";t([n+"Event",n+"PageView",n+"Exception",n+"Trace",n+"DependencyData",n+"Metric",n+"PageViewPerformance","start"+r,"stop"+r,"start"+o,"stop"+o,"addTelemetryInitializer","setAuthenticatedUserContext","clearAuthenticatedUserContext","flush"]),m.SeverityLevel={Verbose:0,Information:1,Warning:2,Error:3,Critical:4};var s=(d.extensionConfig||{}).ApplicationInsightsAnalytics||{};if(!0!==d[I]&&!0!==s[I]){var c="onerror";t(["_"+c]);var u=T[c];T[c]=function(e,t,n,a,i){var r=u&&u(e,t,n,a,i);return!0!==r&&m["_"+c]({message:e,url:t,lineNumber:n,columnNumber:a,error:i}),r},d.autoExceptionInstrumented=!0}return m}(y.cfg);function a(){y.onInit&&y.onInit(n)}(T[t]=n).queue&&0===n.queue.length?(n.queue.push(a),n.trackPageView({})):a()}(window,document,{
|
|
|
|
|
src: "https://js.monitor.azure.com/scripts/b/ai.2.min.js", // The SDK URL Source
|
|
|
|
|
// name: "appInsights", // Global SDK Instance name defaults to "appInsights" when not supplied
|
|
|
|
|
// ld: 0, // Defines the load delay (in ms) before attempting to load the sdk. -1 = block page load and add to head. (default) = 0ms load after timeout,
|
|
|
|
|
@ -80,7 +80,7 @@ src: "https://js.monitor.azure.com/scripts/b/ai.2.min.js", // The SDK URL Source
|
|
|
|
|
crossOrigin: "anonymous", // When supplied this will add the provided value as the cross origin attribute on the script tag
|
|
|
|
|
// onInit: null, // Once the application insights instance has loaded and initialized this callback function will be called with 1 argument -- the sdk instance (DO NOT ADD anything to the sdk.queue -- As they won't get called)
|
|
|
|
|
cfg: { // Application Insights Configuration
|
|
|
|
|
instrumentationKey: "INSTRUMENTATION_KEY"
|
|
|
|
|
connectionString: "YOUR_CONNECTION_STRING"
|
|
|
|
|
}});
|
|
|
|
|
</script>
|
|
|
|
|
```
|
|
|
|
|
@ -137,7 +137,7 @@ onInit: function (sdk) {
|
|
|
|
|
});
|
|
|
|
|
}, // Once the application insights instance has loaded and initialized this method will be called
|
|
|
|
|
cfg: { // Application Insights Configuration
|
|
|
|
|
instrumentationKey: "YOUR_INSTRUMENTATION_KEY"
|
|
|
|
|
connectionString: "YOUR_CONNECTION_STRING"
|
|
|
|
|
}});
|
|
|
|
|
</script>
|
|
|
|
|
```
|
|
|
|
|
@ -181,7 +181,7 @@ After JS script has loaded, include the following snippet to initialize Applicat
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
var snippet = {
|
|
|
|
|
config: {
|
|
|
|
|
instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
|
|
|
|
|
connectionString: "InstrumentationKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
var init = new Microsoft.ApplicationInsights.ApplicationInsights(snippet);
|
|
|
|
|
@ -473,11 +473,11 @@ If you are using the current application insights PRODUCTION SDK (1.0.20) and wa
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**b)** NPM scenario:
|
|
|
|
|
Call downloadAndSetup to download full ApplicationInsights script from CDN and initialize it with instrumentation key.
|
|
|
|
|
Call downloadAndSetup to download full ApplicationInsights script from CDN and initialize it with connection string.
|
|
|
|
|
|
|
|
|
|
```ts
|
|
|
|
|
appInsights.downloadAndSetup({
|
|
|
|
|
instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
|
|
|
|
|
connectionString: "InstrumentationKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
|
|
|
|
|
url: "https://js.monitor.azure.com/scripts/b/ai.2.min.js"
|
|
|
|
|
});
|
|
|
|
|
```
|
|
|
|
|
@ -516,7 +516,7 @@ Usage:
|
|
|
|
|
```ts
|
|
|
|
|
const customPluginInstance = new YourCustomPlugin()
|
|
|
|
|
const appInsights = new ApplicationInsights({ config: {
|
|
|
|
|
instrumentationKey: 'YOUR_INSTRUMENTATION_KEY_GOES_HERE',
|
|
|
|
|
connectionString: 'YOUR_CONNECTION_STRING_GOES_HERE',
|
|
|
|
|
extensions: [customPluginInstance]
|
|
|
|
|
// Other Configuration Options...
|
|
|
|
|
}});
|
|
|
|
|
|
Nev
GitHub