Feat: Add a Metric to Track the Total of Probes Running

[haricnugraha]

Monika Pull Request (PR)

What feature/issue does this PR add

• Add a metric to track total probe running.
• Implement an abort controller to prevent unnecessary requests and free up resources.

How did you implement / how did you fix it

Added

• Added monika_probe_running_total metric to track the running total of Monika probes.
• Added events for probe start and finish to monitor probe activity.
• Added Prometheus configuration and instructions for local monitoring with Docker compose.

Changed

• Updated @types/node to version 18 for better type support.
• Implemented an abort controller for probe processing to prevent unnecessary requests and free up resources.
• Refactored code to use an abstract class and method to ensure implementation in child classes.

How to test

1. Use the following configuration.

probes:
  - id: "1"
    requests:
      - url: http://example.com
  - id: "2"
    requests:
      - url: https://example.com
  - id: "3"
    requests:
      - url: https://example.com
  - id: "4"
    requests:
      - url: https://example.com
  - id: "5"
    requests:
      - url: https://example.com
  - id: "6"
    requests:
      - url: https://example.com
  - id: "7"
    requests:
      - url: https://example.com
  - id: "8"
    requests:
      - url: https://example.com
  - id: "9"
    requests:
      - url: https://example.com
  - id: "10"
    requests:
      - url: https://example.com

2. Run Prometheus. Run docker compose -f ./dev/prometheus/docker-compose.yaml up.
3. Run Monika with the Prometheus flag. Run npm start -- --prometheus 3001.
4. Open Prometheus Expression Browser. Visit http://localhost:9090/graph.
5. Input sum(monika_probe_running_total) and click the Execute button.
6. Click the Graph tab.
7. Change the configuration to test the abort controller.

Demo

Graph

Abort Controller

Before

before.mp4

After

after.mp4

[codecov]

Codecov Report

Attention: 15 lines in your changes are missing coverage. Please review.

Comparison is base (e6a6be2) 63.86% compared to head (763bc5c) 63.71%.

Files	Patch %	Lines
src/plugins/metrics/prometheus/collector.ts	20.00%	7 Missing and 1 partial ⚠️
src/components/probe/index.ts	57.14%	1 Missing and 2 partials ⚠️
src/utils/ip.ts	33.33%	1 Missing and 1 partial ⚠️
src/components/probe/prober/factory.ts	0.00%	1 Missing ⚠️
src/looper/index.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1222      +/-   ##
==========================================
- Coverage   63.86%   63.71%   -0.16%     
==========================================
  Files         111      111              
  Lines        3277     3296      +19     
  Branches      561      566       +5     
==========================================
+ Hits         2093     2100       +7     
- Misses        998     1006       +8     
- Partials      186      190       +4     

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

[sapiderman]

good pr 👍🏽

worked for me

[dennypradipta]

Nicely done.