artillery/lib/telemetry.js

Cloud-scale load testing. https://www.artillery.io

/* 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, name: ciName } = require('ci-info');
const chalk = require('chalk');
const {
  readArtilleryConfig,
  updateArtilleryConfig
} = require('./utils-config');
const debug = require('debug')('telemetry');

const POSTHOG_TOKEN = '_uzX-_WJoVmE_tsLvu0OFD2tpd0HGz72D5sU1zM2hbs';

const noop = () => {};

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

const isEnabled = () => {
  return typeof process.env.ARTILLERY_DISABLE_TELEMETRY === 'undefined';
};

const init = () => {
  const telemetryDisabled = !isEnabled();

  const debugEnabled =
    typeof process.env.ARTILLERY_TELEMETRY_DEBUG !== 'undefined';

  let telemetryDefaults = {};
  try {
    telemetryDefaults = JSON.parse(process.env.ARTILLERY_TELEMETRY_DEFAULTS);
  } catch (err) {
    // fail silently
  }

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

  const capture = (client) => {
    return (event, data = {}) => {
      let eventPayload;

      if (telemetryDisabled) {
        eventPayload = {
          event,
          distinctId: 'artillery-core',
          properties: {
            $ip: 'not-collected'
          }
        };
      } else {
        eventPayload = {
          event,
          distinctId: data.distinctId || 'artillery-core',
          properties: {
            ...data,
            version: artilleryVersion,
            os: process.platform,
            isCi: isCI,
            $ip: 'not-collected'
          }
        };

        eventPayload.properties = Object.assign(
          eventPayload.properties,
          telemetryDefaults
        );

        if (isCI) {
          eventPayload.properties.ciName = ciName;
        }
      }

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

      try {
        debug({ eventPayload });
        client.capture(eventPayload);
      } catch (err) {
        debug(err);
      }
    };
  };

  const shutdown = (client) => async () => {
    try {
      await client.shutdownAsync();
    } catch (err) {
      debug(err);
    }
  };

  try {
    const PostHog = require('posthog-node').PostHog;
    const client = new PostHog(POSTHOG_TOKEN, {
      flushInterval: 100
    });

    telemetry.capture = capture(client);
    telemetry.shutdown = shutdown(client);
  } catch (err) {
    debug(err);
  }

  return telemetry;
};

module.exports = { init, notice, isEnabled };