artillery/lib/telemetry.js

Flexible and powerful toolkit for load and functional testing

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

'use strict';

const { version: artilleryVersion } = require('../package.json');
const isCi = require('is-ci');
const chalk = require('chalk');
const { readArtilleryConfig, updateArtilleryConfig } = require('./util');

const noop = () => {};
const POSTHOG_TOKEN = '_uzX-_WJoVmE_tsLvu0OFD2tpd0HGz72D5sU1zM2hbs';

const notice = () => {
  console.log('  Telemetry is on. Learn more: https://artillery.io/docs/resources/core/telemetry.html');
};

const firstRunMessage = () => {
  const { telemetryFirstRunMsg } = readArtilleryConfig();

  if (isCi || telemetryFirstRunMsg) {
    return;
  }

  notice();

  updateArtilleryConfig({ telemetryFirstRunMsg: true });
};

const init = () => {
  const telemetryDisabled = ['true', '1'].includes(
    process.env.ARTILLERY_DISABLE_TELEMETRY
  );
  const debugEnabled = ['true', '1'].includes(
    process.env.ARTILLERY_TELEMETRY_DEBUG
  );

  const telemetry = {
    capture: noop,
    shutdown: noop,
  };

  if (telemetryDisabled) {
    return telemetry;
  }

  firstRunMessage();

  const capture = (client) => {
    return (event, data = {}) => {
      const eventPayload = {
        event,
        distinctId: 'artillery-core',
        properties: {
          ...data,
          version: artilleryVersion,
          os: process.platform,
          isCi,
          $ip: null,
        },
      };

      if (debugEnabled) {
        console.log(
          chalk.yellow(`Telemetry data: ${JSON.stringify(eventPayload)}`)
        );

        return;
      }

      try {
        client.capture(eventPayload);
      } catch (err) {
        // fail silently
      }
    };
  };

  const shutdown = (client) => () => {
    try {
      client.shutdown();
    } catch (err) {
      // fail silently
    }
  };

  try {
    const PostHog = require('posthog-node');
    const client = new PostHog(POSTHOG_TOKEN);

    telemetry.capture = capture(client);
    telemetry.shutdown = shutdown(client);
  } catch (err) {
    // fail silently
  }

  return telemetry;
};

module.exports = { init, notice };