feat: add GraphQL and MongoDB Prometheus metrics

[Copilot]

Implementation Complete: GraphQL and MongoDB Metrics

Summary

Successfully added comprehensive metrics for GraphQL and MongoDB operations to Hawk API.

Metrics Implemented

GraphQL Metrics (3 metrics)

• hawk_gql_operation_duration_seconds - Histogram tracking GraphQL operation duration by operation name and type
• hawk_gql_operation_errors_total - Counter tracking failed GraphQL operations by operation name and error type
• hawk_gql_resolver_duration_seconds - Histogram tracking resolver execution time per type, field, and operation

MongoDB Metrics (2 metrics)

• hawk_mongo_command_duration_seconds - Histogram tracking MongoDB command duration by command, collection, and database
• hawk_mongo_command_errors_total - Counter tracking failed MongoDB commands by command and error code

Recent Fixes

• Fixed collection name extraction from MongoDB command events (was showing "unknown")
• Added proper TypeScript type annotations to GraphQL plugin to ensure compatibility with Apollo Server 3.x
• Added null check for event.command to prevent undefined access errors in some MongoDB operations

Files Modified

• src/metrics/index.ts - Updated to register new metrics
• src/metrics/graphql.ts - New file with GraphQL metrics and Apollo Server plugin (with proper types)
• src/metrics/mongodb.ts - New file with MongoDB metrics and monitoring setup (with safe null checks)
• src/mongo.ts - Updated to enable MongoDB command monitoring
• src/index.ts - Updated to add GraphQL metrics plugin to Apollo Server
• test/integration/cases/metrics.test.ts - Added tests for new metrics
• docs/METRICS.md - Updated documentation with new metrics details

Technical Details

• Apollo Server plugin properly typed with ApolloServerPlugin and GraphQLRequestListener interfaces
• MongoDB command monitoring uses native MongoDB driver events with safe null checks
• Collection names are correctly extracted from command object when available
• All metrics follow Prometheus naming conventions with hawk_ prefix
• Metrics are automatically exposed on the existing /metrics endpoint
• Build and lint pass successfully

Original prompt

---

This section details on the original issue you should resolve

<issue_title>chore(devops): add graphql and mongo metrics</issue_title>
<issue_description>Now we have #541 Prometheus setup and basic NodeJs and HTTP metrics.

Add more metrics:

• GraphQL resolvers, directives, etc
• Mongo requests

Nice to have metrics:

GraphQL Metrics

Metric Name	Description	Purpose
hawk_gql_operation_duration_seconds	Histogram of total GraphQL operation duration by operation name and type.	Identify slow API operations (P95/P99 latency).
hawk_gql_operation_errors_total	Counter of failed GraphQL operations grouped by operation name and error class.	Detect increased error rates and failing operations.
hawk_gql_resolver_duration_seconds	Histogram of resolver execution time per type / field / operation.	Find slow or CPU-intensive resolvers that degrade overall performance.
hawk_gql_resolvers_per_request	Histogram of total number of resolvers executed per GraphQL request.	Detect N+1 query patterns and over-nested requests.
hawk_gql_response_bytes	Histogram of serialized GraphQL response size per operation.	Identify heavy payloads increasing latency or bandwidth.
hawk_gql_dataloader_batch_size	Histogram of Dataloader batch sizes per loader type.	Detect inefficient batching (too many small queries).
hawk_gql_dataloader_cache_hit_ratio	Gauge showing cache hit ratio of each Dataloader.	Measure Dataloader effectiveness and caching efficiency.

MongoDB Metrics

Metric Name	Description	Purpose
hawk_mongo_command_duration_seconds	Histogram of MongoDB command duration by command, collection, and db.	Detect slow queries and high-latency collections.
hawk_mongo_docs_returned	Histogram of number of documents returned by command.	Find queries returning excessive data.
hawk_mongo_command_errors_total	Counter of failed MongoDB commands grouped by command and error code.	Track transient or persistent database errors.
hawk_mongo_index_used	Counter indicating which index was used by executed queries.	Detect queries running without indexes or using suboptimal ones.
hawk_mongo_stage_duration_seconds	Histogram of aggregation pipeline stage durations (e.g. $lookup, $group).	Identify heavy stages inside aggregation pipelines.
hawk_mongo_response_bytes	Histogram of MongoDB response payload size by command and collection.	Reveal large result sets affecting network or memory usage.
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #543

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fastdl.mongodb.org
  • Triggering command: /usr/local/bin/node ./postinstall.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[neSpecc]

@copilot ci failed,

FAIL test/integration/cases/health.test.ts
tests-1  |   ● Server health › Server is healthy
tests-1  | 
tests-1  |     connect ECONNREFUSED 172.18.0.4:4000

[Copilot]

@copilot ci failed,

...

Fixed in commit e510da1. Added proper TypeScript type annotations (ApolloServerPlugin and GraphQLRequestListener) to the GraphQL metrics plugin to ensure compatibility with Apollo Server 3.x, which should resolve the server startup issue.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fastdl.mongodb.org
  • Triggering command: /usr/local/bin/node ./postinstall.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[neSpecc]

@copilot seems like your changes for getting collection name leads error in some resolvers:

Jest tests are failed:

FAIL test/models/businessOperationsFactory.test.ts
  ● Business operation factory › should create operation instance

    TypeError: Cannot read properties of undefined (reading 'insert')

      62 |        */
      63 |       // eslint-disable-next-line @typescript-eslint/no-explicit-any
    > 64 |       const collection = (event.command as any)[event.commandName] || 'unknown';
         |                           ^
      65 |       const db = event.databaseName || 'unknown';
      66 |
      67 |       mongoCommandDuration

      at MongoClient.<anonymous> (src/metrics/mongodb.ts:64:27)
      at NativeTopology.<anonymous> (node_modules/mongodb/lib/operations/connect.js:679:19)
      at Server.<anonymous> (node_modules/mongodb/lib/core/utils.js:23:71)
      at ConnectionPool.<anonymous> (node_modules/mongodb/lib/core/utils.js:23:71)
      at Connection.<anonymous> (node_modules/mongodb/lib/core/utils.js:23:71)

[Copilot]

@copilot seems like your changes for getting collection name leads error in some resolvers:

Jest tests are failed:
...

Fixed in commit 67b84a3. Added null check for event.command before accessing it: event.command ? ((event.command as any)[event.commandName] || 'unknown') : 'unknown'. This prevents the "Cannot read properties of undefined" error when the command object is not present in some MongoDB events.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fastdl.mongodb.org
  • Triggering command: /usr/local/bin/node ./postinstall.js (dns block)
  • Triggering command: /usr/local/bin/node /home/REDACTED/work/hawk.api.nodejs/hawk.api.nodejs/node_modules/.bin/jest --coverage test/models/businessOperationsFactory.test.ts (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• fastdl.mongodb.org
  • Triggering command: /usr/local/bin/node ./postinstall.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[codecov-commenter]

Codecov Report

❌ Patch coverage is 61.70213% with 36 lines in your changes missing coverage. Please review.
✅ Project coverage is 62.41%. Comparing base (0eced98) to head (095f446).
⚠️ Report is 35 commits behind head on master.

Files with missing lines	Patch %	Lines
src/metrics/graphql.ts	18.51%	22 Missing ⚠️
src/metrics/mongodb.ts	74.07%	13 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #544      +/-   ##
==========================================
- Coverage   66.66%   62.41%   -4.26%     
==========================================
  Files          11       14       +3     
  Lines         174      290     +116     
  Branches       24       44      +20     
==========================================
+ Hits          116      181      +65     
- Misses         54      104      +50     
- Partials        4        5       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.