vX: Add agent os to telemetry (#18)

CHANGELOG.md

@@ -4,6 +4,16 @@
 Task 6.0.3
 - Fix minimum agent requirement to `2.206.1` ([#13](https://github.com/qetza/replacetokens-task/issues/13)).
 - Fix paths in sources incompatible with `fast-glob` syntax on win32 ([#16](https://github.com/qetza/replacetokens-task/issues/16)).
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
+Task 5.3.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
+Task 4.4.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
+Task 3.12.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
 
 ## 5.0.2
 Task 6.0.2

README.md

@@ -319,6 +319,7 @@ The following **anonymous** data is send:
 - the **hash** of your collection id
 - the **hash** of your project id and pipeline definition id
 - the hosting (`server` or `cloud`)
+- the agent OS (`Windows`, `macOS` or `Linux`)
 - the inputs values for
   - _addBOM_
   - _charsToEscape_

tasks/ReplaceTokensV3/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.12.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
 ## 3.12.0
 - Add support for `indent` transformation with indent size and indent first line parameters ([326](https://github.com/qetza/vsts-replacetokens-task/issues/326)).
 - Add support for `REPLACETOKENS_TELEMETRY_OPTOUT` environment variable.

tasks/ReplaceTokensV3/README.md

@@ -240,6 +240,7 @@ The following **anonymous** data is send:
 - the **hash** of your project id and pipeline definition id
 - the pipeline type (`build` or `release`)
 - the hosting (`server` or `services`)
+- the agent OS (`Windows`, `macOS` or `Linux`)
 - the input values for
   - _actionOnMissing_
   - _charsToEscape_

tasks/ReplaceTokensV3/index.ts

@@ -520,6 +520,19 @@ async function run() {
       .digest('hex');
     telemetryEvent.pipelineType = tl.getVariable('release.releaseid') ? 'release' : 'build';
     telemetryEvent.serverType = !serverType || serverType.toLowerCase() !== 'hosted' ? 'server' : 'cloud';
+    telemetryEvent.os = (() => {
+      const os = tl.getVariable('Agent.OS');
+      switch (os) {
+        case 'Windows_NT':
+          return 'Windows';
+        case 'Darwin':
+          return 'macOS';
+        case 'Linux':
+          return 'Linux';
+        default:
+          return os || 'unknown';
+      }
+    })();
 
     // load inputs
     const root: string = tl.getPathInput('rootDirectory', false, true);

tasks/ReplaceTokensV3/task.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 3,
     "Minor": 12,
-    "Patch": 0
+    "Patch": 1
   },
   "instanceNameFormat": "Replace tokens in $(targetFiles)",
   "minimumAgentVersion": "2.105.0",

tasks/ReplaceTokensV3/telemetry.ts

@@ -73,7 +73,8 @@ export default function trackEvent(event: TelemetryEvent, proxyUrl?: string): st
             inlineVariables: event.inlineVariables,
             enableRecursion: event.enableRecursion,
             useLegacyEmptyFeature: event.useLegacyEmptyFeature,
-            useDefaultValue: event.useDefaultValue
+            useDefaultValue: event.useDefaultValue,
+            os: event.os
           }
         }
       }
@@ -170,4 +171,5 @@ export interface TelemetryEvent {
   enableRecursion: boolean;
   useLegacyEmptyFeature: boolean;
   useDefaultValue: boolean;
+  os: string;
 }

tasks/ReplaceTokensV3/tests/L0.ts

@@ -56,6 +56,7 @@ describe('ReplaceTokens v3 L0 suite', function () {
     process.env['SYSTEM_COLLECTIONID'] = 'col01';
     process.env['SYSTEM_TEAMPROJECTID'] = 'project01';
     process.env['SYSTEM_DEFINITIONID'] = 'def01';
+    process.env['AGENT_OS'] = 'Windows_NT';
 
     if (fs.existsSync(tmp)) removeFolder(tmp);
 
@@ -67,6 +68,7 @@ describe('ReplaceTokens v3 L0 suite', function () {
     delete process.env['SYSTEM_COLLECTIONID'];
     delete process.env['SYSTEM_TEAMPROJECTID'];
     delete process.env['SYSTEM_DEFINITIONID'];
+    delete process.env['AGENT_OS'];
   });
 
   afterEach(() => {
@@ -165,7 +167,7 @@ describe('ReplaceTokens v3 L0 suite', function () {
 
           tr.stdout.should.include('telemetry sent');
           tr.stdout.should.match(
-            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"3\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"failed"}}}}/
+            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"3\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"failed","os":"Windows"}}}}/
           );
         },
         tr,
@@ -190,7 +192,7 @@ describe('ReplaceTokens v3 L0 suite', function () {
 
           tr.stdout.should.include('telemetry sent');
           tr.stdout.should.match(
-            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"3\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"succeed","tokenPrefix":"#{","tokenSuffix":"}#","pattern":"#\\\\{\\\\s\*\(\(\?:\(\?!#\\\\{\)\(\?!\\\\s\*\\\\}#\)\.\)\*\)\\\\s\*\\\\}#","encoding":"auto","keepToken":false,"actionOnMissing":"warn","writeBOM":true,"verbosity":"normal","variableFiles":0,"rules":1,"rulesWithInputWildcard":0,"rulesWithOutputPattern":0,"rulesWithNegativePattern":0,"duration":\d+(?:\.\d+)?,"tokenReplaced":1,"tokenFound":1,"fileProcessed":1,"useLegacyPattern":false,"enableTransforms":false,"transformPrefix":"\(","transformSuffix":"\)","transformPattern":"\\\\s\*\(\.\*\)\\\\\(\\\\s\*\(\(\?:\(\?!\\\\\(\)\(\?!\\\\s\*\\\\\)\)\.\)\*\)\\\\s\*\\\\\)\\\\s\*","transformExecuted":0,"defaultValue":"","defaultValueReplaced":0,"actionOnNoFiles":"continue","inlineVariables":0,"enableRecursion":false,"useLegacyEmptyFeature":false,"useDefaultValue":false}}}}/
+            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"3\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"succeed","tokenPrefix":"#{","tokenSuffix":"}#","pattern":"#\\\\{\\\\s\*\(\(\?:\(\?!#\\\\{\)\(\?!\\\\s\*\\\\}#\)\.\)\*\)\\\\s\*\\\\}#","encoding":"auto","keepToken":false,"actionOnMissing":"warn","writeBOM":true,"verbosity":"normal","variableFiles":0,"rules":1,"rulesWithInputWildcard":0,"rulesWithOutputPattern":0,"rulesWithNegativePattern":0,"duration":\d+(?:\.\d+)?,"tokenReplaced":1,"tokenFound":1,"fileProcessed":1,"useLegacyPattern":false,"enableTransforms":false,"transformPrefix":"\(","transformSuffix":"\)","transformPattern":"\\\\s\*\(\.\*\)\\\\\(\\\\s\*\(\(\?:\(\?!\\\\\(\)\(\?!\\\\s\*\\\\\)\)\.\)\*\)\\\\s\*\\\\\)\\\\s\*","transformExecuted":0,"defaultValue":"","defaultValueReplaced":0,"actionOnNoFiles":"continue","inlineVariables":0,"enableRecursion":false,"useLegacyEmptyFeature":false,"useDefaultValue":false,"os":"Windows"}}}}/
           );
         },
         tr,

tasks/ReplaceTokensV4/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 4.4.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
 ## 4.4.0
 - Add support for `indent` transformation with indent size and indent first line parameters ([326](https://github.com/qetza/vsts-replacetokens-task/issues/326)).
 - Add support for `REPLACETOKENS_TELEMETRY_OPTOUT` environment variable.

tasks/ReplaceTokensV4/README.md

@@ -278,6 +278,7 @@ The following **anonymous** data is send:
 - the **hash** of your project id and pipeline definition id
 - the pipeline type (`build` or `release`)
 - the hosting (`server` or `services`)
+- the agent OS (`Windows`, `macOS` or `Linux`)
 - the input values for
   - _actionOnMissing_
   - _charsToEscape_

tasks/ReplaceTokensV4/index.ts

@@ -520,6 +520,19 @@ async function run() {
       .digest('hex');
     telemetryEvent.pipelineType = tl.getVariable('release.releaseid') ? 'release' : 'build';
     telemetryEvent.serverType = !serverType || serverType.toLowerCase() !== 'hosted' ? 'server' : 'cloud';
+    telemetryEvent.os = (() => {
+      const os = tl.getVariable('Agent.OS');
+      switch (os) {
+        case 'Windows_NT':
+          return 'Windows';
+        case 'Darwin':
+          return 'macOS';
+        case 'Linux':
+          return 'Linux';
+        default:
+          return os || 'unknown';
+      }
+    })();
 
     // load inputs
     const root: string = tl.getPathInput('rootDirectory', false, true);

tasks/ReplaceTokensV4/task.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 4,
     "Minor": 4,
-    "Patch": 0
+    "Patch": 1
   },
   "releaseNotes": "Added output variables (breaking change).<br/>Added token pattern dropdown (breaking change).",
   "instanceNameFormat": "Replace tokens in $(targetFiles)",

tasks/ReplaceTokensV4/telemetry.ts

@@ -74,7 +74,8 @@ export default function trackEvent(event: TelemetryEvent, proxyUrl?: string): st
             inlineVariables: event.inlineVariables,
             enableRecursion: event.enableRecursion,
             useLegacyEmptyFeature: event.useLegacyEmptyFeature,
-            useDefaultValue: event.useDefaultValue
+            useDefaultValue: event.useDefaultValue,
+            os: event.os
           }
         }
       }
@@ -172,4 +173,5 @@ export interface TelemetryEvent {
   enableRecursion: boolean;
   useLegacyEmptyFeature: boolean;
   useDefaultValue: boolean;
+  os: string;
 }

tasks/ReplaceTokensV4/tests/L0.ts

@@ -56,6 +56,7 @@ describe('ReplaceTokens v4 L0 suite', function () {
     process.env['SYSTEM_COLLECTIONID'] = 'col01';
     process.env['SYSTEM_TEAMPROJECTID'] = 'project01';
     process.env['SYSTEM_DEFINITIONID'] = 'def01';
+    process.env['AGENT_OS'] = 'Windows_NT';
 
     if (fs.existsSync(tmp)) removeFolder(tmp);
 
@@ -67,6 +68,7 @@ describe('ReplaceTokens v4 L0 suite', function () {
     delete process.env['SYSTEM_COLLECTIONID'];
     delete process.env['SYSTEM_TEAMPROJECTID'];
     delete process.env['SYSTEM_DEFINITIONID'];
+    delete process.env['AGENT_OS'];
   });
 
   afterEach(() => {
@@ -165,7 +167,7 @@ describe('ReplaceTokens v4 L0 suite', function () {
 
           tr.stdout.should.include('telemetry sent');
           tr.stdout.should.match(
-            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"4\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"failed"}}}}/
+            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"4\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"failed","os":"Windows"}}}}/
           );
         },
         tr,
@@ -190,7 +192,7 @@ describe('ReplaceTokens v4 L0 suite', function () {
 
           tr.stdout.should.include('telemetry sent');
           tr.stdout.should.match(
-            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"4\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"succeed","tokenPrefix":"#{","tokenSuffix":"}#","pattern":"#\\\\{\\\\s\*\(\(\?:\(\?!#\\\\{\)\(\?!\\\\s\*\\\\}#\)\.\)\*\)\\\\s\*\\\\}#","encoding":"auto","keepToken":false,"actionOnMissing":"warn","writeBOM":true,"verbosity":"normal","variableFiles":0,"rules":1,"rulesWithInputWildcard":0,"rulesWithOutputPattern":0,"rulesWithNegativePattern":0,"duration":\d+(?:\.\d+)?,"tokenReplaced":1,"tokenFound":1,"fileProcessed":1,"useLegacyPattern":false,"enableTransforms":false,"transformPrefix":"\(","transformSuffix":"\)","transformPattern":"\\\\s\*\(\.\*\)\\\\\(\\\\s\*\(\(\?:\(\?!\\\\\(\)\(\?!\\\\s\*\\\\\)\)\.\)\*\)\\\\s\*\\\\\)\\\\s\*","transformExecuted":0,"defaultValue":"","defaultValueReplaced":0,"tokenPattern":"default","actionOnNoFiles":"continue","inlineVariables":0,"enableRecursion":false,"useLegacyEmptyFeature":false,"useDefaultValue":false}}}}/
+            /\{"name":"Microsoft\.ApplicationInsights\.Dev\.\*+\.Event","time":"[^"]+","iKey":"\*+","tags":\{"ai\.application\.ver":"4\.\d+\.\d+","ai\.cloud\.role":"server","ai\.internal\.sdkVersion":"replacetokens:1\.0\.0","ai\.operation\.id":"([^"]+)","ai\.operation\.name":"replacetokens-task","ai\.operation\.parentId":"\|\1","ai\.user\.accountId":"494d0aad9d06c4ddb51d5300620122ce55366a9382b3cc2835ed5f0e2e67b4d0","ai\.user\.authUserId":"b98ed03d3eec376dcc015365c1a944e3ebbcc33d30e3261af3f4e4abb107aa82"},"data":\{"baseType":"EventData","baseData":\{"ver":"2","name":"tokens\.replaced","properties":\{"preview":false,"pipelineType":"build","result":"succeed","tokenPrefix":"#{","tokenSuffix":"}#","pattern":"#\\\\{\\\\s\*\(\(\?:\(\?!#\\\\{\)\(\?!\\\\s\*\\\\}#\)\.\)\*\)\\\\s\*\\\\}#","encoding":"auto","keepToken":false,"actionOnMissing":"warn","writeBOM":true,"verbosity":"normal","variableFiles":0,"rules":1,"rulesWithInputWildcard":0,"rulesWithOutputPattern":0,"rulesWithNegativePattern":0,"duration":\d+(?:\.\d+)?,"tokenReplaced":1,"tokenFound":1,"fileProcessed":1,"useLegacyPattern":false,"enableTransforms":false,"transformPrefix":"\(","transformSuffix":"\)","transformPattern":"\\\\s\*\(\.\*\)\\\\\(\\\\s\*\(\(\?:\(\?!\\\\\(\)\(\?!\\\\s\*\\\\\)\)\.\)\*\)\\\\s\*\\\\\)\\\\s\*","transformExecuted":0,"defaultValue":"","defaultValueReplaced":0,"tokenPattern":"default","actionOnNoFiles":"continue","inlineVariables":0,"enableRecursion":false,"useLegacyEmptyFeature":false,"useDefaultValue":false,"os":"Windows"}}}}/
           );
         },
         tr,

tasks/ReplaceTokensV5/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 5.3.1
+- Add agent OS in telemetry ([#5](https://github.com/qetza/replacetokens-task/issues/5)).
+
 ## 5.3.0
 - Add support for `indent` transformation with indent size and indent first line parameters ([326](https://github.com/qetza/vsts-replacetokens-task/issues/326)).
 - Add support for `REPLACETOKENS_TELEMETRY_OPTOUT` environment variable.

tasks/ReplaceTokensV5/README.md

@@ -276,6 +276,7 @@ The following **anonymous** data is send:
 - the **hash** of your project id and pipeline definition id
 - the pipeline type (`build` or `release`)
 - the hosting (`server` or `services`)
+- the agent OS (`Windows`, `macOS` or `Linux`)
 - the input values for
   - _actionOnMissing_
   - _charsToEscape_

tasks/ReplaceTokensV5/index.ts

@@ -519,6 +519,19 @@ async function run() {
       .digest('hex');
     telemetryEvent.pipelineType = tl.getVariable('release.releaseid') ? 'release' : 'build';
     telemetryEvent.serverType = !serverType || serverType.toLowerCase() !== 'hosted' ? 'server' : 'cloud';
+    telemetryEvent.os = (() => {
+      const os = tl.getVariable('Agent.OS');
+      switch (os) {
+        case 'Windows_NT':
+          return 'Windows';
+        case 'Darwin':
+          return 'macOS';
+        case 'Linux':
+          return 'Linux';
+        default:
+          return os || 'unknown';
+      }
+    })();
 
     // load inputs
     const root: string = tl.getPathInput('rootDirectory', false, true);

tasks/ReplaceTokensV5/task.json

@@ -13,7 +13,7 @@
   "version": {
     "Major": 5,
     "Minor": 3,
-    "Patch": 0
+    "Patch": 1
   },
   "releaseNotes": "Migrate to Node10 handler (breaking change).<br/>Add Node16 handler.",
   "instanceNameFormat": "Replace tokens in $(targetFiles)",

tasks/ReplaceTokensV5/telemetry.ts

@@ -74,7 +74,8 @@ export default function trackEvent(event: TelemetryEvent, proxyUrl?: string): st
             inlineVariables: event.inlineVariables,
             enableRecursion: event.enableRecursion,
             useLegacyEmptyFeature: event.useLegacyEmptyFeature,
-            useDefaultValue: event.useDefaultValue
+            useDefaultValue: event.useDefaultValue,
+            os: event.os
           }
         }
       }
@@ -175,4 +176,5 @@ export interface TelemetryEvent {
   enableRecursion: boolean;
   useLegacyEmptyFeature: boolean;
   useDefaultValue: boolean;
+  os: string;
 }