API Endpoints for Nixopus Metrics and Service Uptime

[raghavyuva]

Is your feature request related to a problem? Please describe.

There is no API to expose metrics such as uptime, performance statistics, and operational status. This makes it difficult to integrate with third-party monitoring tools or to observe the health of the system programmatically.

Describe the solution you’d like

• API endpoints that provide:
  • Service uptime and availability status.
  • Request throughput and error rates.
  • Average and percentile response times.
  • Current resource utilization (CPU, memory, disk).
• Support for integration with third-party monitoring systems (e.g., Prometheus, Datadog).
• Optionally, authentication-protected access to metrics endpoints.

Describe alternatives you’ve considered

• Scraping logs and generating metrics manually.
• Relying on infrastructure-level monitoring only.

Additional context

This will improve observability and help with proactive maintenance and scaling decisions.

Subtasks

• Define API routes and response schema for metrics endpoints.
• Implement uptime tracking and expose it via the API.
• Add instrumentation to measure:
  • Average response time.
  • 95th and 99th percentile latency.
  • Request throughput.
  • Error counts and rates.
• Integrate with existing logging/metrics backends if available.
• Secure the endpoints with appropriate authentication.
• Write unit and integration tests for metrics endpoints.
• Document how to use the metrics APIs and example outputs.

Additional Functionality: API Speed and Scale Measurement

Goal

Provide tools and processes to measure:

• Time taken to complete API requests.
• Performance under parallel/concurrent load.
• Baseline and stress test results.

---

Subtasks

• Build a benchmarking utility to run load tests against the API.
• Record response time metrics under different concurrency levels.
• Store and visualize results (e.g., average, median, percentile latencies).
• Document recommended limits and scaling thresholds.
• Integrate automated performance regression tests into CI/CD pipeline.

[panagiotisbellias]

I would like to work on it, can you assign it to me?

[panagiotisbellias]

I’m actively starting work on this issue based on the recent Discord discussion.

High-level solution:

• Expose a /metrics Fuego route for the Nixopus service itself (not apps hosted via Nixopus).
• Collect service-level metrics: uptime, request counts/errors, response times, and CPU/memory/disk usage.
• Output as lightweight JSON that can be scraped or extended later.
• No mandatory Prometheus client dependency; optional Prometheus-style exporter can be added in the future if needed.

I’ll keep the implementation focused and modular so future integration with tools like cAdvisor or prometheus-blackbox is straightforward.

[panagiotisbellias]

Can't find the .env.sample referred here, can someone help?

https://docs.nixopus.com/contributing/#development-setup