Provide ability to specify client info in traces

CHANGELOG.md

@@ -5,6 +5,7 @@ All of the packages in the `apollo-server` repo are released with the same versi
 ### vNEXT
 
 - Update link inside Authentication Docs [PR #1682](https://github.com/apollographql/apollo-server/pull/1682)
+- Provide ability to specify client info in traces [#1631](https://github.com/apollographql/apollo-server/pull/1631)
 
 ### v2.0.8
 

docs/source/api/apollo-server.md

@@ -350,3 +350,13 @@ addMockFunctionsToSchema({
 *  `maskErrorDetails`: boolean
 
    Set to true to remove error details from the traces sent to Apollo's servers. Defaults to false.
+
+* generateClientInfo?: (o: { context: any, extensions?: Record<string, any>}) => ClientInfo;
+
+   Creates the client information that is attached to the traces sent to the
+   Apollo backend. The context field is the execution context passed to the
+   resolvers and the extensions field is the field provided in the request's
+   query, operationName, and variables. `ClientInfo` contains fields for
+   `clientName` and `clientVersion`, which can both be optional. The default
+   value copies the respective fields from the `extensions`'s `clientInfo`
+   field.

packages/apollo-engine-reporting/src/agent.ts

@@ -34,6 +34,11 @@ Traces.encode = function(message, originalWriter) {
   return writer;
 };
 
+export interface ClientInfo {
+  clientName?: string;
+  clientVersion?: string;
+}
+
 export interface EngineReportingOptions {
   // API key for the service. Get this from
   // [Engine](https://engine.apollographql.com) by logging in and creating
@@ -83,6 +88,14 @@ export interface EngineReportingOptions {
   sendReportsImmediately?: boolean;
   // To remove the error message from traces, set this to true. Defaults to false
   maskErrorDetails?: boolean;
+  // Creates the client information attached to the traces sent to the Apollo
+  // backend
+  generateClientInfo?: (
+    o: {
+      context: any;
+      extensions?: Record<string, any>;
+    },
+  ) => ClientInfo;
 
   // XXX Provide a way to set client_name, client_version, client_address,
   // service, and service_version fields. They are currently not revealed in the

packages/apollo-engine-reporting/src/extension.ts

@@ -15,7 +15,7 @@ import {
 } from 'graphql-extensions';
 import { Trace, google } from 'apollo-engine-reporting-protobuf';
 
-import { EngineReportingOptions } from './agent';
+import { EngineReportingOptions, ClientInfo } from './agent';
 import { defaultSignature } from './signature';
 
 // EngineReportingExtension is the per-request GraphQLExtension which creates a
@@ -38,6 +38,12 @@ export class EngineReportingExtension<TContext = any>
     operationName: string,
     trace: Trace,
   ) => void;
+  private generateClientInfo: (
+    o: {
+      context: any;
+      extensions?: Record<string, any>;
+    },
+  ) => ClientInfo;
 
   public constructor(
     options: EngineReportingOptions,
@@ -51,6 +57,10 @@ export class EngineReportingExtension<TContext = any>
     const root = new Trace.Node();
     this.trace.root = root;
     this.nodes.set(responsePathAsString(undefined), root);
+    this.generateClientInfo =
+      options.generateClientInfo ||
+      // Default to using the clientInfo field of the request
+      (({ extensions }) => (extensions && extensions.clientInfo) || {});
   }
 
   public requestDidStart(o: {
@@ -60,6 +70,8 @@ export class EngineReportingExtension<TContext = any>
     variables?: Record<string, any>;
     persistedQueryHit?: boolean;
     persistedQueryRegister?: boolean;
+    context: any;
+    extensions?: Record<string, any>;
   }): EndHandler {
     this.trace.startTime = dateToTimestamp(new Date());
     this.startHrTime = process.hrtime();
@@ -154,6 +166,16 @@ export class EngineReportingExtension<TContext = any>
       });
     }
 
+    // While clientAddress could be a part of the protobuf, we'll ignore it for
+    // now, since the backend does not group by it and Engine frontend will not
+    // support it in the short term
+    const { clientName, clientVersion } = this.generateClientInfo({
+      context: o.context,
+      extensions: o.extensions,
+    });
+    this.trace.clientName = clientName || '';
+    this.trace.clientVersion = clientVersion || '';
+
     return () => {
       this.trace.durationNs = durationHrTimeToNanos(
         process.hrtime(this.startHrTime),

packages/apollo-server-core/src/runHttpQuery.ts

@@ -402,6 +402,7 @@ export async function runHttpQuery(
           : false,
         request: request.request,
         extensions: optionsObject.extensions,
+        queryExtensions: extensions,
         persistedQueryHit,
         persistedQueryRegister,
       };

packages/apollo-server-core/src/runQuery.ts

@@ -66,6 +66,7 @@ export interface QueryOptions {
   cacheControl?: boolean | CacheControlExtensionOptions;
   request: Pick<Request, 'url' | 'method' | 'headers'>;
   extensions?: Array<() => GraphQLExtension>;
+  queryExtensions?: Record<string, any>;
   persistedQueryHit?: boolean;
   persistedQueryRegister?: boolean;
 }
@@ -136,6 +137,7 @@ function doRunQuery(options: QueryOptions): Promise<GraphQLResponse> {
     persistedQueryHit: options.persistedQueryHit,
     persistedQueryRegister: options.persistedQueryRegister,
     context,
+    extensions: options.queryExtensions,
   });
   return Promise.resolve()
     .then(

packages/graphql-extensions/src/index.ts

@@ -81,6 +81,7 @@ export class GraphQLExtensionStack<TContext = any> {
     persistedQueryHit?: boolean;
     persistedQueryRegister?: boolean;
     context: TContext;
+    extensions?: Record<string, any>;
   }): EndHandler {
     return this.handleDidStart(
       ext => ext.requestDidStart && ext.requestDidStart(o),