Send anonymouse usage reporting to Grafana

Author: DefCon-007

README.md

@@ -33,7 +33,7 @@ The following inputs can be used as `step.with` key:
 | `cloud-comment-on-pr` | boolean | `false`  | `true`  | If `true`, the workflow comments a link to the cloud test run on the pull request (if present)                                                                                                                                                                                                       |
 | `only-verify-scripts` | boolean | `false`  | `false` | If `true`, only check if the test scripts are valid and skip the test execution'                                                                                                                                                                                                                     |
 | `debug`               | boolean | `false`  | `false` | If true, the output from k6 will be shown in the action logs, else only the summary will be shown.                                                                                                                                                                                                   |
-
+| `disable-analytics`   | boolean | `false`  | `false` | If true, the anonymous usage analytics reporting will be disabled                                                                                                                                                                                                                                    |
 ## Usage
 
 Following are some examples of using the workflow.

action.yaml

@@ -45,6 +45,10 @@ inputs:
     description: 'If true, the output from k6 will be shown in the action logs, else only the summary will be shown'
     default: "false"
     required: false
+  disable-analytics:
+    description: 'If true, the anonymous usage analytics reporting will be disabled'
+    default: "false"
+    required: false
 
 runs:
   using: node20

src/analytics.ts

@@ -0,0 +1,85 @@
+import crypto from 'crypto'
+import os from 'os'
+import { apiRequest, DEFAULT_RETRY_OPTIONS } from './apiUtils'
+import { getInstalledK6Version } from './k6helper'
+
+const ANALYTICS_SOURCE = 'github-action'
+
+export interface UserSpecifiedAnalyticsData {
+  totalTestScriptsExecuted: number
+  isCloudRun: boolean
+  isUsingFlags: boolean
+  isUsingInspectFlags: boolean
+  failFast: boolean
+  commentOnPr: boolean
+  parallelFlag: boolean
+  cloudRunLocally: boolean
+  onlyVerifyScripts: boolean
+}
+
+interface AnalyticsData {
+  source: string
+  usageStatsId: string
+  osPlatform: string
+  osArch: string
+  osType: string
+  k6Version: string
+
+  totalTestScriptsExecuted: number
+  isCloudRun: boolean
+  isUsingFlags: boolean
+  isUsingInspectFlags: boolean
+  failFast: boolean
+  commentOnPr: boolean
+  parallelFlag: boolean
+  cloudRunLocally: boolean
+  onlyVerifyScripts: boolean
+}
+
+/**
+ * Gets the usage stats id which is an identifier for the invocation of the action
+ * Here we use a hash of GITHUB_ACTION and GITHUB_REPOSITORY to identify the unique users and
+ * club multiple invocations from the same user/repo
+ *
+ * @returns The usage stats id
+ */
+function getUsageStatsId(): string {
+  const githubAction = process.env.GITHUB_ACTION || ''
+  const githubWorkflow = process.env.GITHUB_WORKFLOW || ''
+  return crypto
+    .createHash('sha256')
+    .update(`${githubAction}-${githubWorkflow}`)
+    .digest('hex')
+}
+
+export async function sendAnalytics(
+  userSpecifiedAnalyticsData: UserSpecifiedAnalyticsData
+) {
+  const analyticsData: AnalyticsData = {
+    ...userSpecifiedAnalyticsData,
+    source: ANALYTICS_SOURCE,
+    usageStatsId: getUsageStatsId(),
+    osPlatform: os.platform(),
+    osArch: os.arch(),
+    osType: os.type(),
+    k6Version: getInstalledK6Version(),
+  }
+
+  const url = process.env.GRAFANA_ANALYTICS_URL || 'https://stats.grafana.org'
+
+  try {
+    await apiRequest(
+      url,
+      {
+        method: 'POST',
+        body: JSON.stringify(analyticsData),
+      },
+      {
+        ...DEFAULT_RETRY_OPTIONS,
+        maxRetries: 1,
+      }
+    )
+  } catch (error) {
+    console.error('Error sending analytics:', error)
+  }
+}

src/index.ts

@@ -1,6 +1,7 @@
 import * as core from '@actions/core'
 import { ChildProcess } from 'child_process'
 
+import { sendAnalytics, UserSpecifiedAnalyticsData } from './analytics'
 import { generatePRComment } from './githubHelper'
 import {
   cleanScriptPath,
@@ -35,7 +36,7 @@ export async function run(): Promise<void> {
       'cloud-comment-on-pr'
     )
     const debug = core.getBooleanInput('debug')
-
+    const disableAnalytics = core.getBooleanInput('disable-analytics')
     const allPromises: Promise<void>[] = []
 
     core.debug(`Flag to show k6 progress output set to: ${debug}`)
@@ -72,6 +73,22 @@ export async function run(): Promise<void> {
 
     const isCloud = isCloudIntegrationEnabled()
 
+    if (!disableAnalytics) {
+      const userSpecifiedAnalyticsData: UserSpecifiedAnalyticsData = {
+        totalTestScriptsExecuted: verifiedTestPaths.length,
+        isCloudRun: isCloud,
+        isUsingFlags: flags.length > 0,
+        isUsingInspectFlags: inspectFlags.length > 0,
+        failFast,
+        commentOnPr: shouldCommentCloudTestRunUrlOnPR,
+        parallelFlag: parallel,
+        cloudRunLocally,
+        onlyVerifyScripts,
+      }
+
+      sendAnalytics(userSpecifiedAnalyticsData)
+    }
+
     const commands = testPaths.map((testPath) =>
         generateK6RunCommand(testPath, flags, isCloud, cloudRunLocally)
       ),

src/k6helper.ts

@@ -1,6 +1,6 @@
 // Common helper functions used in the action
 import * as core from '@actions/core'
-import { ChildProcess, spawn } from 'child_process'
+import { ChildProcess, execSync, spawn } from 'child_process'
 import path from 'path'
 import { apiRequest } from './apiUtils'
 import { parseK6Output } from './k6OutputParser'
@@ -243,3 +243,34 @@ export async function fetchChecks(testRunId: string): Promise<Check[]> {
   // Return the checks array from the response
   return response.value
 }
+
+/**
+ * Extracts the semantic version (e.g., "0.56.0") from the full k6 version string which looks like
+ * `k6 v0.56.0 (go1.23.4, darwin/arm64)`.
+ *
+ * @param {string} versionString - The full version string from k6 version command
+ * @returns {string} The semantic version or empty string if not found
+ */
+export function extractK6SemVer(versionString: string): string {
+  // Match pattern like "v0.56.0" and extract just the digits and dots
+  const match = versionString.match(/v(\d+\.\d+\.\d+)/)
+  return match ? match[1] : ''
+}
+
+/**
+ * Gets the installed k6 version using the `k6 version` command.
+ *
+ * @returns The installed k6 version as a semantic version string
+ */
+export function getInstalledK6Version(): string {
+  try {
+    // Use execSync for synchronous output capture
+    const output = execSync('k6 version').toString().trim()
+
+    // Return only the semantic version if requested
+    return extractK6SemVer(output)
+  } catch (error) {
+    console.error('Error executing k6 version:', error)
+    return ''
+  }
+}