chore: add prom client

[chakra-guy]

Explanation

The current state uses a custom metrics extraction function that manually calculates and formats metrics for total connected clients and total rooms. This approach is limited in scope and requires manual maintenance to add or modify metrics.

The solution introduces the use of the Prometheus client library ('prom-client') to handle metrics collection and formatting. This change offers several advantages:

1. Standardized metrics format compatible with Prometheus
2. Automatic collection of numerous Node.js and process-level metrics out-of-the-box
3. Easy addition and customization of application-specific metrics

The changes include:

• Adding 'prom-client' as a dependency
• Replacing the custom 'extractMetrics' function with Prometheus Registry and Gauge metrics
• Updating the metrics endpoint to use the new Prometheus-based metrics collection
• Adding a function to periodically update socket server metrics

References

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.15%. Comparing base (dc4874c) to head (9e5d0ac).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1087   +/-   ##
=======================================
  Coverage   77.15%   77.15%           
=======================================
  Files         180      180           
  Lines        4260     4260           
  Branches     1050     1050           
=======================================
  Hits         3287     3287           
  Misses        973      973           

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

[abretonc7s]

Approved, just one comment that we may want to rename the read to something more specific.

[chakra-guy]

• @SocketSecurity ignore npm/prom-client@15.1.3

@SocketSecurity ignore npm/prom-client@15.1.3

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[abretonc7s]

@SocketSecurity ignore npm/prom-client@15.1.3