fix: use new config keys (#203)

Author: mshanemc

README.md

@@ -8,7 +8,7 @@ This package serves an interface for [Microsoft's Application Insights npm modul
 
 ## Usage
 
-### For long running process:
+### For long running process
 
 ```javascript
 import TelemetryReporter from '@salesforce/telemetry';
@@ -26,11 +26,11 @@ By default, some common properties are hidden for GDPR. This is to protect clien
 const reporter = await TelemetryReporter.create({
   project: 'my-project-name',
   key: 'my-instrumentation-key',
-  gdprSensitiveKeys: []
+  gdprSensitiveKeys: [],
 });
 ```
 
-### For short lived processes:
+### For short lived processes
 
 ```javascript
 import TelemetryReporter from '@salesforce/telemetry';
@@ -48,4 +48,4 @@ reporter.stop();
 
 ## Env Variables
 
-`SFDX_DISABLE_INSIGHTS`: Set to `true` if you want to disable telemetry.
+`SF_DISABLE_TELEMETRY`: Set to `true` if you want to disable telemetry.

src/telemetryReporter.ts

@@ -5,15 +5,13 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import * as os from 'os';
-import { Logger, SfdxConfigAggregator } from '@salesforce/core';
+import { Logger, SfdxConfigAggregator, SfConfigProperties } from '@salesforce/core';
 import { AsyncCreatable, env } from '@salesforce/kit';
 
 import axios from 'axios';
 import { AppInsights, Attributes, Properties, TelemetryOptions } from './appInsights';
 import { TelemetryClient } from './exported';
 
-const DISABLE_TELEMETRY = 'disableTelemetry';
-
 export { TelemetryOptions, Attributes, Properties, TelemetryClient } from './appInsights';
 
 /**
@@ -41,7 +39,8 @@ export class TelemetryReporter extends AsyncCreatable<TelemetryOptions> {
     if (!TelemetryReporter.config) {
       TelemetryReporter.config = await SfdxConfigAggregator.create({});
     }
-    const configValue = TelemetryReporter.config.getPropertyValue(DISABLE_TELEMETRY);
+    const configValue = TelemetryReporter.config.getPropertyValue(SfConfigProperties.DISABLE_TELEMETRY);
+    // SF_DISABLE_TELEMETRY is the proper name for this env that will be cheked by config.getPropertyValue. SFDX_DISABLE_INSIGHTS is present for backwards compatibility
     const sfdxDisableInsights = configValue === 'true' || env.getBoolean('SFDX_DISABLE_INSIGHTS');
     return !sfdxDisableInsights;
   }
@@ -167,7 +166,7 @@ export class TelemetryReporter extends AsyncCreatable<TelemetryOptions> {
    * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
    */
   public isSfdxTelemetryEnabled(): boolean {
-    const configValue = this.config.getPropertyValue(DISABLE_TELEMETRY);
+    const configValue = this.config.getPropertyValue(SfConfigProperties.DISABLE_TELEMETRY);
     const sfdxDisableInsights = configValue === 'true' || env.getBoolean('SFDX_DISABLE_INSIGHTS');
     // isEnabled = !sfdxDisableInsights
     return !sfdxDisableInsights;
@@ -177,11 +176,11 @@ export class TelemetryReporter extends AsyncCreatable<TelemetryOptions> {
     const isEnabled = this.isSfdxTelemetryEnabled();
     if (isEnabled) {
       this.logger.warn(
-        `Telemetry is enabled. This can be disabled by running sfdx force:config:set ${DISABLE_TELEMETRY}=true`
+        `Telemetry is enabled. This can be disabled by running sfdx force:config:set ${SfConfigProperties.DISABLE_TELEMETRY}=true`
       );
     } else {
       this.logger.warn(
-        `Telemetry is disabled. This can be enabled by running sfdx force:config:set ${DISABLE_TELEMETRY}=false`
+        `Telemetry is disabled. This can be enabled by running sfdx force:config:set ${SfConfigProperties.DISABLE_TELEMETRY}=false`
       );
     }
   }