enhance(prom): add operationType label

ardatan · Mar 14, 2024 · 3d59e68 · 3d59e68
1 parent e2fb7ed
commit 3d59e68
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/.changeset/tasty-grapes-smoke.md b/.changeset/tasty-grapes-smoke.md
@@ -0,0 +1,5 @@
+---
+"@graphql-mesh/plugin-prometheus": patch
+---
+
+Add `operationType` to metrics
diff --git a/packages/plugins/prometheus/src/index.ts b/packages/plugins/prometheus/src/index.ts
@@ -96,7 +96,7 @@ export default function useMeshPrometheus(
       typeof pluginOptions.subgraphExecute === 'string'
         ? pluginOptions.subgraphExecute
         : 'graphql_mesh_subgraph_execute_duration';
-    const subgraphExecuteLabelNames = ['subgraphName'];
+    const subgraphExecuteLabelNames = ['subgraphName', 'operationType'];
     subgraphExecuteHistogram = new Histogram({
       name,
       help: 'Time spent on subgraph execution',
@@ -140,7 +140,7 @@ export default function useMeshPrometheus(
       }
       return undefined;
     },
-    onSubgraphExecute({ subgraphName }) {
+    onSubgraphExecute({ subgraphName, executionRequest: { operationType = 'query' } }) {
       if (subgraphExecuteHistogram) {
         const start = Date.now();
         return ({ result }) => {
@@ -149,7 +149,7 @@ export default function useMeshPrometheus(
               onNext({ result }) {
                 if (result.errors) {
                   result.errors.forEach(() => {
-                    subgraphExecuteErrorCounter?.inc({ subgraphName });
+                    subgraphExecuteErrorCounter?.inc({ subgraphName, operationType });
                   });
                 }
               },
@@ -159,6 +159,7 @@ export default function useMeshPrometheus(
                 subgraphExecuteHistogram.observe(
                   {
                     subgraphName,
+                    operationType,
                   },
                   duration,
                 );
@@ -167,14 +168,15 @@ export default function useMeshPrometheus(
           }
           if (result.errors) {
             result.errors.forEach(() => {
-              subgraphExecuteErrorCounter?.inc({ subgraphName });
+              subgraphExecuteErrorCounter?.inc({ subgraphName, operationType });
             });
           }
           const end = Date.now();
           const duration = end - start;
           subgraphExecuteHistogram.observe(
             {
               subgraphName,
+              operationType,
             },
             duration,
           );

diff --git a/packages/plugins/prometheus/tests/prometheus.spec.ts b/packages/plugins/prometheus/tests/prometheus.spec.ts
@@ -64,6 +64,7 @@ describe('Prometheus', () => {
     const metrics = await registry.metrics();
     expect(metrics).toContain('graphql_mesh_subgraph_execute_duration');
     expect(metrics).toContain('subgraphName="TestSubgraph"');
+    expect(metrics).toContain('operationType="query"');
   });
   it('should track subgraph request errors', async () => {
     const res = await serveRuntime.fetch('http://localhost:4000/graphql', {
@@ -87,5 +88,6 @@ describe('Prometheus', () => {
     const metrics = await registry.metrics();
     expect(metrics).toContain('graphql_mesh_subgraph_execute_errors');
     expect(metrics).toContain('subgraphName="TestSubgraph"');
+    expect(metrics).toContain('operationType="query"');
   });
 });