基于matomo实现业务数据埋点采集上报

<!-- Matomo -->
<!-- 联系管理员新建项目后自动生成,放入到项目根目录index.html header标签下，并配置相应的追踪域名地址，即刻生效 -->
<script>
  var _paq = window._paq = window._paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']); // 记录页面视图
  _paq.push(['enableLinkTracking']); // 在所有适用的链接元素上安装链接跟踪
  (function () {
    var u = "https://test-matobo.jnt-express.com.cn/"; // matomo私有服务器地址
    _paq.push(['setTrackerUrl', u + 'matomo.php']); // 指定 Matomo 服务器 URL
    _paq.push(['setSiteId', '9']); // 设置追踪的站点唯一编码(指定网站 ID) 该id将作为唯一标识来区分matomo正在采集数据的应用
    var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
    g.async=true; g.src = u + 'matomo.js'; s.parentNode.insertBefore(g, s); // async 属性指定该脚本SDK将会在加载完毕后执行
  })();
</script>
<!-- End Matomo Code -->

<!-- 将统计代码放入到项目根目录下的index.html的header标签下，注意，该script是新建项目时自动生成的追踪代码-->
<!-- Matomo -->
<script>
  var _paq = window._paq = window._paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="https://test-matobo.jnt-express.com.cn/";
    _paq.push(['setTrackerUrl', u+'matomo.php']);
    _paq.push(['setSiteId', '10']);
    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
    g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Matomo Code -->

/** src/plugins/matomo.ts */ 
export default function useMatomo() {
  /** 页面地址信息上报 */
  const setCustomUrl = (url: string) => {
    ;(window as any)._paq.push(['setCustomUrl', `${url}`])
  }

  /** 页面标题信息上报 */
  const trackPageView = (title: string | any) => {
    ;(window as any)._paq.push(['trackPageView', `${title}`])
  }

  /** 用户信息userId上报 */
  const setUserId = (userId: string | number | boolean) => {
    ;(window as any)._paq.push(['setUserId', `${userId}`])
    ;(window as any)._paq.push(['trackPageView'])
  }

  /** 重置userId，这里多次调用trackAllContentImpressions是为了在退出登录的时候重置调userId，并在下一次登录时重新生成一条最新的记录 */
  const resetUserId = () => {
    // UserID passed to Matomo (see https://developer.matomo.org/guides/tracking-javascript-guide#user-id)
    ;(window as any)._paq.push(['resetUserId'])
    ;(window as any)._paq.push(['trackAllContentImpressions', 'new_visit=1'])
    ;(window as any)._paq.push(['trackPageView'])
    ;(window as any)._paq.push(['trackAllContentImpressions'])
  }

  /**
   * 行为埋点
   * $matomo.trackEvent('行为类别', '事件', 'name', 'value')
   * behaviorCategory  行为类别
   * event 事件
   * name 事件名称
   * value 事件值
   */
  const trackEvent = (behaviorCategory: string, event: string, name: string, value?: string | number) => {
    ;(window as any)._paq.push(['trackEvent', `${behaviorCategory}`, `${event}`, `${name}`])
  }

  return {
    setCustomUrl,
    trackPageView,
    setUserId,
    resetUserId,
    trackEvent
  }
}

<!-- App.vue --> 
<template>
  <ConfigProvider :locale="zhCN">
    <router-view />
  </ConfigProvider>
</template>
<script lang="ts" setup>
  import { onMounted, watch } from 'vue'
  import { ConfigProvider } from 'ant-design-vue'
  import { useRouter } from 'vue-router'
  import zhCN from 'ant-design-vue/lib/locale-provider/zh_CN'
  import useMatomo from '@/plugins/matomo'
  import { useAuthStore } from '@/store/auth'

  const router = useRouter()
  const authStore = useAuthStore()
  const matomo = useMatomo()
  /** 
    在App.vue中记录每个路由切换的路径及页面标题信息；
    sertUserId一般在登录完成之后调用，这里在App.vue中调用是为了解决token存在，spa应用直接进目标页面而跳过登录页无法触发setUserId上报的问题
  */
  watch(
    () => router.currentRoute.value,
    (newValue: any) => {
    // 这里延迟是因为matomo sdk加载是异步非阻塞加载，所以为了能正确的获取到window上matomo的实例，我们这里会有略微延迟
      setTimeout(() => {
        /**
         * 记录跳转页面及页面标题  userCode及nickName均为业务系统数据，此处做拼接传入
         **/
        const name =
          authStore.userInfo?.userCode !== undefined
            ? `${authStore.userInfo?.userCode} | ${authStore.userInfo?.nickName}`
            : ''
        matomo.setUserId(name)
        matomo.setCustomUrl(window.location.href)
        matomo.trackPageView(router.currentRoute.value.meta.title)
      }, 500)
    }
  )

<!--src/login/index.vue -->
<script lang="ts" setup>
  import { reactive, ref, onMounted } from 'vue'
  import useMatomo from '@/plugins/matomo'
  const matomo = useMatomo()

  const jumpPage = (data: any) => {
    /** 登录成功后在跳转之前将业务数据userCode和nickName上报 */
    const { userCode, nickName, menuTree } = data
    const name = `${userCode} | ${nickName}` || ''
    matomo.setUserId(name)
  }
</script>

<!--具体的页面具体的方法中去触发trackEvent-->
<script lang="ts" setup>
  import { reactive, ref, onMounted } from 'vue'
  import useMatomo from '@/plugins/matomo'
  const matomo = useMatomo()

  const exportBtn = () => {
    /** 例如需要记录导出按钮的点击次数，在导出按钮中trackEvent即可 */    
    matomo.trackEvent('品牌监控报表', '导出', 'export')
</script>

/** 官方提供了vue-matomo这个库，仅适用于vue2，vue3方式接入会有问题 */
npm install --save vue-matomo

/** main.js */    
import Vue from 'vue'
import VueMatomo from 'vue-matomo'

Vue.use(VueMatomo, {
  // 请求对应服务域名，如果是私有化部署，可以填写自己内网的私有域名，如果是公网部署填写https://matomo.example.com即可
  host: 'https://matomo.example.com',
  /** 新建项目的script文件中会存在siteId这个变量，这个是跟项目绑定的唯一标识，通过该变量索引查找到对应项目 */
  siteId: 5,
// 最终的追踪js文件名  默认 'piwik'
  trackerFileName: 'matomo',
  siteId: 9,
  router: router,
  // 支持外部链接跟踪
  enableLinkTracking: true,
  // 是否需要在发送追踪信息之前请求许可 默认false
  requireConsent: false,
  // 是否追踪初始页面 默认true
  trackInitialView: true,
  debug: false
});

// 挂载到vue的实例中之后，我们可以使用this.$matomo or window._paq.push or window.Piwik.getTracker 等三种方式来访问均可，此处使用this来访问