Skip to content

README.md

Latest commit

 

History

History
74 lines (45 loc) · 2.25 KB

README.md

File metadata and controls

74 lines (45 loc) · 2.25 KB

Observability & Metrics

Grafana

Codebloom uses Spring Boot Actuator and Prometheus to provide operational insights into the running application. We also collect logs via OpenSearch, which is setup through the DigitalOcean App Platform (view app spec here). Both of these data sources are then fed to a Grafana instance hosted on monitor.tahmid.io

Grafana

All metrics for production & staging can be viewed on monitor.tahmid.io.

Note

Please reach out to @tahminator if you are on the Codebloom dev team & need the credentials to login & view the dashboard

Actuator Endpoints

Spring Boot Actuator exposes operational information about the running application through HTTP endpoints.

Security

All actuator endpoints are protected with HTTP Basic Authentication to prevent unauthorized access to sensitive operational data.

Authentication Details:

  • Authentication Type: HTTP Basic Auth
  • Role Required: ACTUATOR
  • Credentials: Stored in environment variables
    • ACTUATOR_USERNAME - Username for actuator endpoints
    • ACTUATOR_PASSWORD - Password for actuator endpoints (generate with openssl rand -base64 48 | head -c 64)

Available Endpoints

Currently exposed endpoints:

  • /actuator/prometheus - Prometheus-formatted metrics endpoint for scraping

Prometheus Metrics

Prometheus metrics provide detailed insights into application performance, JVM statistics, HTTP requests, and custom business metrics.

Accessing Metrics

Local Development:

http://localhost:8080/actuator/prometheus

(Requires HTTP Basic Auth with actuator credentials)

Staging:

https://stg.codebloom.patinanetwork.org/actuator/prometheus

Production:

https://codebloom.patinanetwork.org/actuator/prometheus

Testing Locally

To test the actuator endpoint locally:

  1. Ensure your .env file has ACTUATOR_USERNAME and ACTUATOR_PASSWORD set
  2. Start the application (just dev)
  3. Access the endpoint using curl:
curl -u actuator:your_password http://localhost:8080/actuator/prometheus

Or use a browser and enter the username/password when prompted.