Merge remote-tracking branch 'origin/copilot/set-up-prometheus-metrics' into stage

Author: neSpecc

.env.sample

@@ -1,6 +1,9 @@
 # API server port
 PORT=4000
 
+# Metrics server port
+METRICS_PORT=9090
+
 # Hawk API database URL
 MONGO_HAWK_DB_URL=mongodb://mongodb:27017/hawk
 

.github/workflows/build-and-push-docker-image.yml

@@ -3,7 +3,7 @@ name: Build and push docker image
 on:
   push:
     branches:
-      - '*'
+      - '**'
     tags:
       - 'v*'
 

.github/workflows/bump-version.yml

@@ -6,9 +6,11 @@ jobs:
   # If pull request was merged then we should check for a package version update
   check-version-update:
     runs-on: ubuntu-22.04
+    outputs:
+      should-bump: ${{ steps.version-check.outputs.should-bump }}
     steps:
       # Checkout to target branch
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -26,20 +28,29 @@ jobs:
         id: packageOld
         uses: codex-team/action-nodejs-package-info@v1
 
-      # Stop workflow and do not bump version if it was changed already
-      - name: Stop workflow and do not bump version if it was changed already
-        uses: andymckay/cancel-action@0.2
-        if: steps.packageOld.outputs.version != steps.packageNew.outputs.version
+      # Check if version should be bumped
+      - name: Check if version should be bumped
+        id: version-check
+        run: |
+          if [ "${{ steps.packageOld.outputs.version }}" == "${{ steps.packageNew.outputs.version }}" ]; then
+            echo "should-bump=true" >> $GITHUB_OUTPUT
+          else
+            echo "should-bump=false" >> $GITHUB_OUTPUT
+          fi
 
   bump-version:
     needs: check-version-update
+    if: needs.check-version-update.outputs.should-bump == 'true'
     runs-on: ubuntu-22.04
     steps:
       # Checkout to target branch
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
 
       # Setup node environment
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v5
         with:
           node-version-file: '.nvmrc'
           registry-url: https://registry.npmjs.org/
@@ -54,7 +65,7 @@ jobs:
         uses: codex-team/action-nodejs-package-info@v1
 
       # Commit version upgrade
-      - uses: EndBug/add-and-commit@v7
+      - uses: EndBug/add-and-commit@v9
         with:
           author_name: github-actions
           author_email: 41898282+github-actions[bot]@users.noreply.github.com

LICENSE

@@ -0,0 +1,96 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             CodeX (Hawk)
+Licensed Work:        hawk.api.nodejs (https://github.com/codex-team/hawk.api.nodejs)
+                      The Licensed Work is © 2025 CodeX
+Additional Use Grant: Self-hosted use for own/internal needs and research/evaluation is permitted.
+                      Using this code to provide a competing error-tracking SaaS or commercial
+                      hosted service without the Licensor’s prior permission is prohibited.
+
+Change Date:          2030-01-01
+
+Change License:       AGPL-3.0
+
+-------------------------------------------------------------------------------
+
+License text copyright © 2024 MariaDB plc, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB plc.
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY
+APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN “AS IS” BASIS. LICENSOR
+HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING
+(WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to
+use this License’s text to license your works, and to refer to it using the
+trademark “Business Source License”, as long as you comply with the Covenants
+of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date not later than the fourth anniversary of the first
+   publicly available distribution of a specific version of the Licensed Work
+   under this License.
+
+4. Not to modify this License in any other way.
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License for MariaDB
+products, please visit the MariaDB Business Source License FAQ.
+For more information on the use of the Business Source License generally,
+please visit the Adopting and Developing Business Source License FAQ.

README.md

@@ -1,5 +1,7 @@
 # Hawk API
 
+![License](https://img.shields.io/badge/license-BSL--1.1-orange)
+
 ## Start API
 For deployment (both in production and in development), you can use Docker.
 See Docker instructions [here](DOCKER.md).
@@ -29,3 +31,8 @@ You can view API Schema visualization in `/voyager` page in your browser. To see
 
 Run `yarn migrations:up` command to apply migration revisions or
 `yarn migrations:down` to rollback the last revision.
+
+## License
+
+Source code is available under **Business Source License 1.1 (BSL 1.1)**.
+See [`LICENSE`](./LICENSE) for terms, including:

docs/METRICS.md

@@ -0,0 +1,120 @@
+# Prometheus Metrics
+
+This application exposes Prometheus-compatible metrics on a separate port from the main API server.
+
+## Configuration
+
+The metrics server runs on a separate port configured via the `METRICS_PORT` environment variable:
+
+```bash
+# Default: 9090
+METRICS_PORT=9090
+```
+
+Add this to your `.env` file. See `.env.sample` for reference.
+
+## Metrics Endpoint
+
+The metrics are served at:
+
+```
+http://localhost:9090/metrics
+```
+
+(Replace `9090` with your configured `METRICS_PORT` if different)
+
+## Available Metrics
+
+### Default Node.js Metrics
+
+The following default Node.js metrics are automatically collected:
+
+- **nodejs_version_info** - Node.js version information
+- **process_cpu_user_seconds_total** - Total user CPU time spent in seconds
+- **process_cpu_system_seconds_total** - Total system CPU time spent in seconds
+- **nodejs_heap_size_total_bytes** - Total heap size in bytes
+- **nodejs_heap_size_used_bytes** - Used heap size in bytes
+- **nodejs_external_memory_bytes** - External memory in bytes
+- **nodejs_heap_space_size_total_bytes** - Total heap space size in bytes
+- **nodejs_heap_space_size_used_bytes** - Used heap space size in bytes
+- **nodejs_eventloop_lag_seconds** - Event loop lag in seconds
+- **nodejs_eventloop_lag_min_seconds** - Minimum event loop lag
+- **nodejs_eventloop_lag_max_seconds** - Maximum event loop lag
+- **nodejs_eventloop_lag_mean_seconds** - Mean event loop lag
+- **nodejs_eventloop_lag_stddev_seconds** - Standard deviation of event loop lag
+- **nodejs_eventloop_lag_p50_seconds** - 50th percentile event loop lag
+- **nodejs_eventloop_lag_p90_seconds** - 90th percentile event loop lag
+- **nodejs_eventloop_lag_p99_seconds** - 99th percentile event loop lag
+
+### Custom HTTP Metrics
+
+#### http_request_duration_seconds (Histogram)
+
+Duration of HTTP requests in seconds, labeled by:
+- `method` - HTTP method (GET, POST, etc.)
+- `route` - Request route/path
+- `status_code` - HTTP status code
+
+Buckets: 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10 seconds
+
+#### http_requests_total (Counter)
+
+Total number of HTTP requests, labeled by:
+- `method` - HTTP method (GET, POST, etc.)
+- `route` - Request route/path
+- `status_code` - HTTP status code
+
+## Testing
+
+### Manual Testing
+
+You can test the metrics endpoint using curl:
+
+```bash
+curl http://localhost:9090/metrics
+```
+
+Or run the provided test script:
+
+```bash
+./test-metrics.sh
+```
+
+### Integration Tests
+
+Integration tests for metrics are located in `test/integration/cases/metrics.test.ts`.
+
+Run them with:
+
+```bash
+npm run test:integration
+```
+
+## Implementation Details
+
+The metrics implementation uses the `prom-client` library and consists of:
+
+1. **Metrics Module** (`src/metrics/index.ts`):
+   - Initializes a Prometheus registry
+   - Configures default Node.js metrics collection
+   - Defines custom HTTP metrics (duration histogram and request counter)
+   - Provides middleware for tracking HTTP requests
+   - Creates a separate Express app for serving metrics
+
+2. **Integration** (`src/index.ts`):
+   - Adds metrics middleware to the main Express app
+   - Starts metrics server on a separate port
+   - Keeps metrics server isolated from main API traffic
+
+## Prometheus Configuration
+
+To scrape these metrics with Prometheus, add the following to your `prometheus.yml`:
+
+```yaml
+scrape_configs:
+  - job_name: 'hawk-api'
+    static_configs:
+      - targets: ['localhost:9090']
+```
+
+Adjust the target host and port according to your deployment.