Provide ability to specify client info in traces

Adds the createClientInfo to apollo-engine-reporting, which enables the differentiation of clients based on the request, operation, and variables. This could be extended to include the response. However for the first release. It doesn't quite make sense.
apollographql · Sep 7, 2018 · c9a415d · c9a415d
1 parent 8875022
commit c9a415d
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/docs/source/api/apollo-server.md b/docs/source/api/apollo-server.md
@@ -348,3 +348,9 @@ addMockFunctionsToSchema({
 *  `maskErrorDetails`: boolean
 
    Set to true to remove error details from the traces sent to Apollo's servers. Defaults to false.
+
+* createClientInfo?: (o: { request: Request, queryString?: string, parsedQuery?: DocumentNode, variables: Record<string, any>}) => ClientInfo;
+
+   Creates the client information that is attached to the traces sent to the
+   Apollo backend. `ClientInfo` contains fields for `clientName`,
+   `clientVersion`, and `clientAddress`, which can all be optional.
diff --git a/packages/apollo-engine-reporting/src/agent.ts b/packages/apollo-engine-reporting/src/agent.ts
@@ -8,7 +8,7 @@ import {
   Trace,
 } from 'apollo-engine-reporting-protobuf';
 
-import { fetch, Response } from 'apollo-server-env';
+import { fetch, Request, Response } from 'apollo-server-env';
 import * as retry from 'async-retry';
 
 import { EngineReportingExtension } from './extension';
@@ -34,6 +34,12 @@ Traces.encode = function(message, originalWriter) {
   return writer;
 };
 
+export interface ClientInfo {
+  clientName?: string;
+  clientAddress?: 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 +89,16 @@ 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
+  createClientInfo?: (
+    o: {
+      request: Request;
+      queryString?: string;
+      parsedQuery?: DocumentNode;
+      variables: 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

diff --git a/packages/apollo-engine-reporting/src/extension.ts b/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
@@ -145,6 +145,19 @@ export class EngineReportingExtension<TContext = any>
       });
     }
 
+    const { clientName, clientAddress, clientVersion } =
+      (this.options.createClientInfo &&
+        this.options.createClientInfo({
+          request: o.request,
+          queryString: o.queryString,
+          parsedQuery: o.parsedQuery,
+          variables: o.variables,
+        })) ||
+      ({} as ClientInfo);
+    this.trace.clientName = clientName || '';
+    this.trace.clientAddress = clientAddress || '';
+    this.trace.clientVersion = clientVersion || '';
+
     return () => {
       this.trace.durationNs = durationHrTimeToNanos(
         process.hrtime(this.startHrTime),