feat(reporting): Add reportTiming option to EngineReportingOptions

CHANGELOG.md

@@ -7,7 +7,8 @@ The version headers in this history reflect the versions of Apollo Server itself
 
 ### vNEXT
 
-- _Nothing yet! Stay tuned._
+- `apollo-engine-reporting`: Added a `reportTiming` API to allow trace reporting to be enabled or disabled on a per request basis. The option takes either a boolean or a predicate function that takes a [`GraphQLRequestContextDidResolveOperation`](https://github.com/apollographql/apollo-server/blob/a926b7eedbb87abab2ec70fb03d71743985cb18d/packages/apollo-server-types/src/index.ts#L185-L190) or [`GraphQLRequestContextDidEncounterErrors`](https://github.com/apollographql/apollo-server/blob/a926b7eedbb87abab2ec70fb03d71743985cb18d/packages/apollo-server-types/src/index.ts#L191-L195) and returns a boolean. If the boolean is false the request will not be instrumented for tracing and no trace will be sent to Apollo Graph Manager.  The default is `true` so all traces will get instrumented and sent, which is the same as the previous default behavior. [PR #3918](https://github.com/apollographql/apollo-server/pull/3918)
+- `apollo-engine-reporting`: Removed `GraphQLServerOptions.reporting`. It isn't known whether a trace will be reported at the beginning of the request because of the above change. We believe this field was only used internally within Apollo Server; let us know if this is a problem and we can suggest alternatives. Additionally, the field requestContext.metrics.captureTraces is now initialized later in the request pipeline.  [PR #3918](https://github.com/apollographql/apollo-server/pull/3918)
 
 ### v2.14.4
 

docs/package.json

@@ -6,8 +6,8 @@
     "serve": "gatsby serve"
   },
   "dependencies": {
-    "gatsby": "2.23.1",
-    "gatsby-theme-apollo-docs": "4.2.3",
+    "gatsby": "2.23.3",
+    "gatsby-theme-apollo-docs": "4.2.6",
     "react": "16.13.1",
     "react-dom": "16.13.1"
   }

docs/source/api/apollo-server.md

@@ -480,6 +480,18 @@ addMockFunctionsToSchema({
 
    A human-readable name for the variant of a schema (i.e. staging, EU). Setting this value will cause metrics to be segmented in the Apollo Graph Manager UI. Additionally schema validation with a graph variant will only check metrics associated with the same string.
 
+* `reportTiming`: Boolean | async (GraphQLRequestContextDidResolveOperation | GraphQLRequestContextDidEncounterErrors) => Boolean
+
+    Specify whether to instrument an operation to send traces and metrics to Apollo.
+    This may resolve to a boolean or a async function returning a promise resolving to a boolean.
+    If the option resolves to false for an operation the operation will not be instrumented
+    and no metrics information will be sent to Apollo.
+
+    The function will receive a `GraphQLRequestContextDidResolveOperation` with client and operation
+    information or a `GraphQLRequestContextDiDEncounterErrors` in the case an operation failed
+    to resolve properly. This allows the choice of whether to include a given request in trace
+    and metric reporting to be made on a per-request basis. The default value is true.
+
 *  `generateClientInfo`: (GraphQLRequestContext) => ClientInfo **AS 2.2**
 
    Creates a client context(ClientInfo) based on the request pipeline's

package.json

@@ -61,13 +61,13 @@
   },
   "devDependencies": {
     "@types/async-retry": "1.4.2",
-    "@types/aws-lambda": "8.10.53",
+    "@types/aws-lambda": "8.10.56",
     "@types/body-parser": "1.19.0",
     "@types/bunyan": "1.8.6",
     "@types/connect": "3.4.33",
     "@types/fast-json-stable-stringify": "2.0.0",
     "@types/hapi": "17.8.8",
-    "@types/ioredis": "4.16.4",
+    "@types/ioredis": "4.16.5",
     "@types/jest": "25.2.3",
     "@types/koa-router": "7.4.1",
     "@types/lodash": "4.14.155",
@@ -83,10 +83,10 @@
     "@types/qs-middleware": "1.0.1",
     "@types/request": "2.48.5",
     "@types/request-promise": "4.1.46",
-    "@types/supertest": "2.0.8",
+    "@types/supertest": "2.0.9",
     "@types/test-listen": "1.1.0",
     "@types/type-is": "1.6.3",
-    "@types/uuid": "7.0.3",
+    "@types/uuid": "7.0.4",
     "@types/ws": "7.2.5",
     "apollo-fetch": "0.7.0",
     "apollo-link": "1.2.14",
@@ -113,7 +113,7 @@
     "js-sha256": "0.9.0",
     "koa": "2.12.0",
     "koa-router": "7.4.0",
-    "lerna": "3.22.0",
+    "lerna": "3.22.1",
     "log4js": "4.5.1",
     "memcached-mock": "0.1.0",
     "mock-req": "0.2.0",