Field level usage metrics with errors

.changeset/tricky-items-sit.md

@@ -0,0 +1,7 @@
+---
+'@graphql-hive/gateway-plugin-console-sdk': minor
+'@graphql-hive/core': minor
+'hive': minor
+---
+
+Support coordinate level resolution and error reporting

docker/configs/clickhouse/logging.xml

@@ -1,5 +1,6 @@
 <clickhouse>
     <logger>
         <console>true</console>
+        <level>information</level>
     </logger>
 </clickhouse>

integration-tests/package.json

@@ -19,6 +19,8 @@
     "@esm2cjs/execa": "6.1.1-cjs.1",
     "@graphql-hive/apollo": "workspace:*",
     "@graphql-hive/core": "workspace:*",
+    "@graphql-hive/gateway-plugin-console-sdk": "workspace:*",
+    "@graphql-hive/gateway-runtime": "^1.0.0 || ^2.0.0",
     "@graphql-typed-document-node/core": "3.2.0",
     "@hive/commerce": "workspace:*",
     "@hive/postgres": "workspace:*",

integration-tests/testkit/flow.ts

@@ -1339,6 +1339,30 @@ export function updateBaseSchema(input: UpdateBaseSchemaInput, token: string) {
   });
 }
 
+export function readTotalRequests(
+  reference: GraphQLSchema.TargetReferenceInput,
+  period: GraphQLSchema.DateRangeInput,
+  token: string,
+) {
+  return execute({
+    document: graphql(`
+      query IntegrationTests_ReadTotalRequests(
+        $reference: TargetReferenceInput!
+        $period: DateRangeInput!
+      ) {
+        target(reference: $reference) {
+          totalRequests(period: $period)
+        }
+      }
+    `),
+    token,
+    variables: {
+      reference,
+      period,
+    },
+  });
+}
+
 export function readClientStats(
   reference: GraphQLSchema.TargetReferenceInput,
   period: GraphQLSchema.DateRangeInput,
@@ -1442,6 +1466,46 @@ export function readOperationsStats(
   });
 }
 
+export function readSchemaCoordinateStats(
+  selector: {
+    organizationSlug: string;
+    projectSlug: string;
+    targetSlug: string;
+    schemaCoordinate: string;
+  },
+  period: GraphQLSchema.DateRangeInput,
+  token: string,
+) {
+  return execute({
+    document: graphql(`
+      query readSchemaCoordinateStats(
+        $selector: TargetSelectorInput!
+        $schemaCoordinate: String!
+        $period: DateRangeInput!
+      ) {
+        target(reference: { bySelector: $selector }) {
+          id
+          schemaCoordinateStats(schemaCoordinate: $schemaCoordinate, period: $period) {
+            totalRequests
+            totalResolutions
+            totalFailures
+          }
+        }
+      }
+    `),
+    token,
+    variables: {
+      selector: {
+        organizationSlug: selector.organizationSlug,
+        projectSlug: selector.projectSlug,
+        targetSlug: selector.targetSlug,
+      },
+      schemaCoordinate: selector.schemaCoordinate,
+      period,
+    },
+  });
+}
+
 export function readOperationBody(
   selector: {
     organizationSlug: string;

integration-tests/testkit/seed.ts

@@ -50,7 +50,9 @@ import {
   readClientStats,
   readOperationBody,
   readOperationsStats,
+  readSchemaCoordinateStats,
   readTokenInfo,
+  readTotalRequests,
   updateBaseSchema,
   updateMemberRole,
   updateMetricAlertRule,
@@ -1142,6 +1144,22 @@ export function initSeed() {
                     )
                   ).expectNoGraphQLErrors();
                 },
+                async readSchemaCoordinateStats(
+                  schemaCoordinate: string,
+                  period: GraphQLSchema.DateRangeInput,
+                  ttarget: TargetOverwrite = target,
+                ) {
+                  return await readSchemaCoordinateStats(
+                    {
+                      organizationSlug: organization.slug,
+                      projectSlug: project.slug,
+                      targetSlug: ttarget.slug,
+                      schemaCoordinate,
+                    },
+                    period,
+                    ownerToken,
+                  ).then(r => r.expectNoGraphQLErrors());
+                },
                 async readOperationBody(hash: string, ttarget: TargetOverwrite = target) {
                   const operationBodyResult = await readOperationBody(
                     {
@@ -1195,7 +1213,7 @@ export function initSeed() {
                   const from = formatISO(opts?.from ?? subHours(Date.now(), 1));
                   const to = formatISO(opts?.to ?? Date.now());
                   const check = async () => {
-                    const statsResult = await readOperationsStats(
+                    const statsResult = await readTotalRequests(
                       {
                         bySelector: {
                           organizationSlug: organization.slug,
@@ -1207,15 +1225,9 @@ export function initSeed() {
                         from,
                         to,
                       },
-                      {},
                       ownerToken,
                     ).then(r => r.expectNoGraphQLErrors());
-                    const totalRequests =
-                      statsResult.target?.operationsStats.operations.edges.reduce(
-                        (total, edge) => total + edge.node.count,
-                        0,
-                      );
-                    return totalRequests == n;
+                    return statsResult.target?.totalRequests == n;
                   };
 
                   return pollFor(check);

integration-tests/tests/api/app-deployments.spec.ts

@@ -2142,7 +2142,7 @@ test('app deployment usage reporting', async () => {
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { a }`),
       schema: buildASTSchema(parse(sdl)),
@@ -2720,7 +2720,7 @@ test('activeAppDeployments filters by lastUsedBefore', async () => {
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { hello }`),
       schema: buildASTSchema(parse(sdl)),
@@ -2882,7 +2882,7 @@ test('activeAppDeployments applies OR logic between lastUsedBefore and neverUsed
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { hello }`),
       schema: buildASTSchema(parse(sdl)),
@@ -3159,7 +3159,7 @@ test('activeAppDeployments filters by name combined with lastUsedBefore', async
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { hello }`),
       schema: buildASTSchema(parse(sdl)),
@@ -5602,7 +5602,7 @@ test('retire app deployment with --force bypasses protection', async () => {
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { hello }`),
       schema: buildASTSchema(parse(sdl)),

integration-tests/tests/api/target/usage.spec.ts

@@ -2246,7 +2246,7 @@ test.concurrent(
     `);
 
     function collectA() {
-      client.collectUsage()(
+      client.collectUsage().finish(
         {
           document: queryA,
           schema,
@@ -2259,7 +2259,7 @@ test.concurrent(
     }
 
     function collectB() {
-      client.collectUsage()(
+      client.collectUsage().finish(
         {
           document: queryB,
           schema,
@@ -2465,7 +2465,7 @@ test.concurrent(
     `);
 
     function collectA() {
-      client.collectUsage()(
+      client.collectUsage().finish(
         {
           document: queryA,
           schema,
@@ -2637,7 +2637,7 @@ test.concurrent(
     `);
 
     function collectA() {
-      client.collectUsage()(
+      client.collectUsage().finish(
         {
           document: queryA,
           schema,
@@ -2649,7 +2649,7 @@ test.concurrent(
       );
     }
     function collectB() {
-      client.collectUsage()(
+      client.collectUsage().finish(
         {
           document: queryB,
           schema,
@@ -2927,7 +2927,7 @@ test.concurrent(
 
     // Now let's make subscription insignificant by making 3 queries
 
-    client.collectUsage()(
+    client.collectUsage().finish(
       {
         document: parse('{ a }'),
         schema,
@@ -2937,7 +2937,7 @@ test.concurrent(
       },
       {},
     );
-    client.collectUsage()(
+    client.collectUsage().finish(
       {
         document: parse('{ a }'),
         schema,
@@ -2947,7 +2947,7 @@ test.concurrent(
       },
       {},
     );
-    client.collectUsage()(
+    client.collectUsage().finish(
       {
         document: parse('{ a }'),
         schema,

integration-tests/tests/cli/app.spec.ts

@@ -493,7 +493,7 @@ test('app:retire --force bypasses protection', async () => {
     },
   });
 
-  await client.collectUsage()(
+  await client.collectUsage().finish(
     {
       document: parse(`query { hello }`),
       schema: buildASTSchema(parse(sdl)),