Package Exports
- vue3-application-insights
- vue3-application-insights/dist/index.js
- vue3-application-insights/dist/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue3-application-insights) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
vue3-application-insights
Vue 3 plugin to simplify integration with Azure Application Insights.
Installation
npm install vue3-application-insightsGet started
import { createApp } from "vue";
import router from "./router";
import { AppInsightsPlugin, AppInsightsPluginOptions } from "vue3-application-insights";
const aiOptions: AppInsightsPluginOptions = {
appName: "<app name for events>", // Prefix for route events
connectionString: "<your connection string>",
router: router,
trackAppErrors: true,
};
createApp(App).use(router).use(AppInsightsPlugin, aiOptions).mount("#app");Track custom event:
import { useAppInsights } from "vue3-application-insights";
const appInsights = useAppInsights();
appInsights.trackEvent({
name: "custom_event",
});Options
| Name | Type | Required / Default value | Description |
|---|---|---|---|
| appInsightsInstance | ApplicationInsights | No* | Custom self made Application Insights instance to use. |
| appInsightsConfig | Snippet | No* | Provide custom Application Insights configuration. |
| connectionString | string | No* | Simply provide Application Insights connection string only. |
| router | Router | No | Instance of Router (from vue-router) to track navigation between pages. The event name will have format: [appName] <route.name> |
| appName | string | No | App name for router events. If not provided will not present in the event name. |
| trackInitialPageView | boolean | No / False | Track initial page view or track it only when router is ready. |
| trackAppErrors | boolean | No / False | Track global errors of the app. |
| onLoaded | (appInsights: ApplicationInsights) => any | No | Custom modifications / action to execute after Application Insights instance is created. |
*One of these three values should be set to connect with your Application Insights instance. If more than one is set the top one (based on the option list) will be used.
Inspired by vue-application-insights.