Narcoleptic's Patch Mangler

    @salesforce/telemetry
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.1 • Public • Published

    sfdx-telemetry

    This package serves an interface for Microsoft's Application Insights npm module.

    Install

    yarn add @salesforce/telemetry --save

    Usage

    For long running process:

    import TelemetryReporter from '@salesforce/telemetry';
    
    const reporter = await TelemetryReporter.create({ project: 'my-project-name', key: 'my-instrumentation-key' });
    reporter.start();
    
    // Now you can send events and the reporter will batch and send.
    reporter.sendTelemetryEvent('event-name', { foo: 'bar', executionTime: 0.5912 });

    By default, some common properties are hidden for GDPR. This is to protect client side tools that send telemetry. If the owner of the long running process controls the machines too, you can redefine the GDPR sensitive fields.

    const reporter = await TelemetryReporter.create({
      project: 'my-project-name',
      key: 'my-instrumentation-key',
      gdprSensitiveKeys: []
    });

    For short lived processes:

    import TelemetryReporter from '@salesforce/telemetry';
    
    const reporter = await TelemetryReporter.create({ project: 'my-project-name', key: 'my-instrumentation-key' });
    
    // Send events.
    reporter.sendTelemetryEvent('event-name', { foo: 'bar', executionTime: 0.5912 });
    
    // When all finished sending events, stop the reporter or the process may hang.
    reporter.stop();

    Note: For short lived processes, the telemetry can take 0-3 seconds to send all events to the server on stop, and even longer if there is a timeout. It is recommended to send telemetry in a detached spawned process. i.e. spawn(..., { stdio: 'ignore'}).unref();

    Env Variables

    SFDX_DISABLE_INSIGHTS: Set to true if you want to disable telemetry.

    Install

    npm i @salesforce/telemetry

    DownloadsWeekly Downloads

    69,899

    Version

    3.2.1

    License

    BSD-3-Clause

    Unpacked Size

    35.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • dlouvton
    • jc-sf
    • pvandyk-sf
    • dbreese-salesforce
    • ashokrudraraju
    • dhersam
    • demianbrecht
    • mbettio
    • damilareolowoniyi
    • mmadialagan
    • spoorti.nidagundi
    • rodesp
    • mjrust
    • salesforce-releases
    • conal
    • vazexqi
    • joshwlewis
    • mpsenn
    • sfdc_iamigo
    • kevinv11n
    • tbliss
    • byao
    • pmdartus
    • futuremint_sf
    • interactivellama
    • ekashida
    • gr8gatsby
    • ravi.jayaramappa
    • apapko
    • krisgraysfdc
    • jleen-sfdc
    • jqian
    • cwallsf
    • dhagberg-sf
    • michaelhoefer
    • tlohr
    • khawkins
    • amphro
    • tconn
    • dehru
    • abdulsattar
    • jodarove
    • rxu-sfdc
    • amcconnell-sf
    • nolanlawson
    • sfdctaka
    • fernomac
    • cafreeman
    • jimjag
    • ivarley
    • jbartolotta-sfdc