vue3-application-insights

vue3-application-insights

Vue 3 plugin to simplify integration with Azure Application Insights.

Installation

npm install vue3-application-insights

Setup

Minimal

import { createApp } from "vue";
import { AppInsightsPlugin, type AppInsightsPluginOptions } from "vue3-application-insights";

const aiOptions: AppInsightsPluginOptions = {
  connectionString: "<your connection string>",
};

createApp(App).use(AppInsightsPlugin, aiOptions).mount("#app");

With router and app errors

import { createApp } from "vue";
import router from "./router";
import { AppInsightsPlugin, type AppInsightsPluginOptions } from "vue3-application-insights";

const aiOptions: AppInsightsPluginOptions = {
  connectionString: "<your connection string>",
  router: router,
  trackAppErrors: true,
};

createApp(App).use(router).use(AppInsightsPlugin, aiOptions).mount("#app");

Custom Application Insights configuration

const aiOptions: AppInsightsPluginOptions = {
  appInsightsConfig: {
    // See Application Insights specifications: https://github.com/microsoft/ApplicationInsights-JS#configuration
    config: {
      connectionString: "<your connection string>",
    },
  },
  router: router,
  trackAppErrors: true,
};

All options example

const aiOptions: AppInsightsPluginOptions = {
  connectionString: import.meta.env.VITE_APPLICATION_INSIGHTS_CONNECTION_STRING, // Get value from .env file
  router: router,
  appName: 'Vue + Vite app', // For route event to be like: [appName] <route.name>
  trackAppErrors: true,
  cloudRole: 'frontend',
  cloudRoleInstance: 'vue-app',
  onLoaded: (appInsights: ApplicationInsights) => {
    // Custom changes for application insights
  }
};

Setup with Nuxt

Add a client side Nuxt plugin. To do this, add a file to your plugins directory, its file name ending in .client.ts:

import { AppInsightsPlugin, type AppInsightsPluginOptions } from "vue3-application-insights";

export default defineNuxtPlugin((nuxtApp) => {
  const config = useRuntimeConfig();
  const router = useRouter();

  const options: AppInsightsPluginOptions = {
    connectionString: "<your connection string>",
    router: router,
    trackAppErrors: true,
  };
  nuxtApp.vueApp.use(AppInsightsPlugin, options);
});

Using in components

Track custom event

import { useAppInsights } from "vue3-application-insights";

const appInsights = useAppInsights();

appInsights.trackEvent({
  name: "custom_event",
});

See official docs for sending custom telemetry to Azure Portal.

Options

*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.