adjust telemetry names for connect event (#181)

lrlna · web-flow · commit dfc252e22376 · 2020-05-20T13:21:04.000+02:00
* adjust telemetry names for connect event
* Title Case all analytics events
diff --git a/packages/cli-repl/package-lock.json b/packages/cli-repl/package-lock.json
diff --git a/packages/cli-repl/package.json b/packages/cli-repl/package.json
@@ -52,7 +52,7 @@
     "minimist": "^1.2.5",
     "mkdirp": "^1.0.3",
     "mongodb-ace-autocompleter": "^0.4.1",
-    "mongodb-build-info": "^1.0.0",
+    "mongodb-build-info": "^1.1.0",
     "mongodb-redact": "^0.2.0",
     "nanobus": "^4.4.0",
     "pino": "^5.16.0",
diff --git a/packages/cli-repl/src/connect-info.spec.ts b/packages/cli-repl/src/connect-info.spec.ts
@@ -1,3 +1,4 @@
+/* eslint camelcase: 0, @typescript-eslint/camelcase: 0 */
 import { expect } from 'chai';
 import getConnectInfo from './connect-info';
 
@@ -74,15 +75,17 @@ describe('getConnectInfo', function() {
 
   it('reports on an enterprise version >=3.2 of mongodb with credentials', function() {
     const output = {
-      isAtlas: true,
-      isLocalhost: false,
-      serverVersion: '3.2.0-rc2',
-      isEnterprise: true,
-      authType: 'LDAP',
-      isDataLake: false,
-      dlVersion: null,
-      isGenuine: true,
-      serverName: 'mongodb',
+      is_atlas: true,
+      is_localhost: false,
+      server_version: '3.2.0-rc2',
+      is_enterprise: true,
+      auth_type: 'LDAP',
+      is_data_lake: false,
+      dl_version: null,
+      is_genuine: true,
+      non_genuine_server_name: 'mongodb',
+      server_arch: 'x86_64',
+      server_os: 'osx',
       uri: ATLAS_URI
     };
     expect(getConnectInfo(
@@ -94,15 +97,17 @@ describe('getConnectInfo', function() {
 
   it('reports on an enterprise version >=3.2 of mongodb with no credentials', function() {
     const output = {
-      isAtlas: true,
-      isLocalhost: false,
-      serverVersion: '3.2.0-rc2',
-      isEnterprise: true,
-      authType: null,
-      isDataLake: false,
-      dlVersion: null,
-      isGenuine: true,
-      serverName: 'mongodb',
+      is_atlas: true,
+      is_localhost: false,
+      server_version: '3.2.0-rc2',
+      is_enterprise: true,
+      auth_type: null,
+      is_data_lake: false,
+      dl_version: null,
+      is_genuine: true,
+      non_genuine_server_name: 'mongodb',
+      server_arch: 'x86_64',
+      server_os: 'osx',
       uri: ATLAS_URI
     };
     expect(getConnectInfo(
diff --git a/packages/cli-repl/src/connect-info.ts b/packages/cli-repl/src/connect-info.ts
@@ -1,38 +1,48 @@
+/* eslint camelcase: 0, @typescript-eslint/camelcase: 0 */
+// ^ segment data is in snake_case: forgive me javascript, for i have sinned.
+
 import getBuildInfo from 'mongodb-build-info';
 
 interface ConnectInfo {
-  isAtlas: boolean;
-  isLocalhost: boolean;
-  serverVersion: string;
-  isEnterprise: boolean;
+  is_atlas: boolean;
+  is_localhost: boolean;
+  server_version: string;
+  server_os?: string;
+  server_arch?: string;
+  is_enterprise: boolean;
+  auth_type?: string;
+  is_data_lake: boolean;
+  dl_version?: string;
+  is_genuine: boolean;
+  non_genuine_server_name: string;
   uri: string;
-  authType?: string;
-  isDataLake: boolean;
-  dlVersion?: string;
-  isGenuine: boolean;
-  serverName: string;
 }
 
 export default function getConnectInfo(uri: string, buildInfo: any, cmdLineOpts: any, topology: any): ConnectInfo {
-  const { isGenuine, serverName } =
+  const { isGenuine: is_genuine, serverName: non_genuine_server_name } =
     getBuildInfo.getGenuineMongoDB(buildInfo, cmdLineOpts);
-  const { isDataLake, dlVersion } = getBuildInfo.getDataLake(buildInfo);
+  const { isDataLake: is_data_lake, dlVersion: dl_version }
+    = getBuildInfo.getDataLake(buildInfo);
 
   // get this information from topology rather than cmdLineOpts, since not all
   // connections are able to run getCmdLineOpts command
-  const authType = topology.s.credentials
+  const auth_type = topology.s.credentials
     ? topology.s.credentials.mechanism : null;
+  const { serverOs: server_os, serverArch: server_arch }
+    = getBuildInfo.getBuildEnv(buildInfo);
 
   return {
-    isAtlas: getBuildInfo.isAtlas(uri),
-    isLocalhost: getBuildInfo.isLocalhost(uri),
-    serverVersion: buildInfo.version,
-    isEnterprise: getBuildInfo.isEnterprise(buildInfo),
+    is_atlas: getBuildInfo.isAtlas(uri),
+    is_localhost: getBuildInfo.isLocalhost(uri),
+    server_version: buildInfo.version,
+    server_os,
     uri,
-    authType,
-    isDataLake,
-    dlVersion,
-    isGenuine,
-    serverName
+    server_arch,
+    is_enterprise: getBuildInfo.isEnterprise(buildInfo),
+    auth_type,
+    is_data_lake,
+    dl_version,
+    is_genuine,
+    non_genuine_server_name
   };
 }
diff --git a/packages/cli-repl/src/logger.ts b/packages/cli-repl/src/logger.ts
@@ -1,4 +1,4 @@
-/* eslint no-console:0, no-empty-function: 0 */
+/* eslint no-console: 0, no-empty-function: 0, camelcase: 0, @typescript-eslint/camelcase: 0 */
 
 import redactInfo from 'mongodb-redact';
 import Analytics from 'analytics-node';
@@ -36,16 +36,18 @@ interface ShowEvent {
 }
 
 interface ConnectEvent {
+  is_atlas: boolean;
+  is_localhost: boolean;
+  server_version: string;
+  server_os?: string;
+  server_arch?: string;
+  is_enterprise: boolean;
+  auth_type?: string;
+  is_data_lake: boolean;
+  dl_version?: string;
+  is_genuine: boolean;
+  non_genuine_server_name: string;
   uri: string;
-  isAtlas: boolean;
-  isLocalhost: boolean;
-  serverVersion: string;
-  isEnterprise: boolean;
-  authType: string;
-  isDataLake: boolean;
-  dlVersion?: string;
-  isGenuine: boolean;
-  serverName: string;
 }
 
 // set up a noop, in case we are not able to connect to segment.
@@ -55,10 +57,10 @@ NoopAnalytics.prototype.identify = function(): void {};
 NoopAnalytics.prototype.track = function(): void {};
 
 export default function logger(bus: any, logDir: string): void {
-  const sessionID = new ObjectId(Date.now());
-  const logDest = path.join(logDir, `${sessionID}_log`);
+  const session_id = new ObjectId(Date.now());
+  const logDest = path.join(logDir, `${session_id}_log`);
   const log = pino({ name: 'monogsh' }, pino.destination(logDest));
-  console.log(`Current sessionID: ${sessionID}`);
+  console.log(`Current sessionID: ${session_id}`);
   let userId;
   let telemetry;
 
@@ -74,14 +76,14 @@ export default function logger(bus: any, logDir: string): void {
   bus.on('mongosh:connect', function(args: ConnectEvent) {
     const connectionUri = redactPwd(args.uri);
     delete args.uri;
-    const params = { sessionID, userId, connectionUri, ...args };
+    const params = { session_id, userId, connectionUri, ...args };
     log.info('mongosh:connect', params);
 
     if (telemetry) {
       analytics.track({
         userId,
-        event: 'mongosh:connect',
-        properties: { sessionID, connectionUri, ...args }
+        event: 'New Connection',
+        properties: { session_id, ...args }
       });
     }
   });
@@ -105,7 +107,7 @@ export default function logger(bus: any, logDir: string): void {
     if (telemetry && error.name.includes('Mongosh')) {
       analytics.track({
         userId,
-        event: 'mongosh:error',
+        event: 'Error',
         properties: { error }
       });
     }
@@ -117,7 +119,7 @@ export default function logger(bus: any, logDir: string): void {
     if (telemetry) {
       analytics.track({
         userId,
-        event: 'mongosh:help'
+        event: 'Help'
       });
     }
   });
@@ -132,7 +134,7 @@ export default function logger(bus: any, logDir: string): void {
     if (telemetry) {
       analytics.track({
         userId,
-        event: 'mongosh:use'
+        event: 'Use'
       });
     }
   });
@@ -143,7 +145,7 @@ export default function logger(bus: any, logDir: string): void {
     if (telemetry) {
       analytics.track({
         userId,
-        event: 'mongosh:show',
+        event: 'Show',
         properties: { method: args.method }
       });
     }
@@ -166,7 +168,7 @@ export default function logger(bus: any, logDir: string): void {
     if (telemetry) {
       analytics.track({
         userId,
-        event: 'mongosh:api-call',
+        event: 'Api Call',
         properties: redactInfo(properties)
       });
     }
