prometheus

Overview ¶

Package prometheus provides Prometheus metrics integration bundle for Forge applications.

The Prometheus bundle provides:

• Automatic application metrics (HTTP requests, gRPC calls, errors)
• Custom metrics registration and collection
• Integration with existing framework components
• Health check metrics and monitoring
• Connection pool and database metrics
• JWT authentication metrics
• Circuit breaker and retry metrics
• Grafana dashboard configuration

Basic Usage ¶

Add the Prometheus bundle to your application:

config := prometheus.Config{
	Namespace: "myservice",
	Subsystem: "api",
	EnableDefaultMetrics: true,
	EnableHTTPMetrics: true,
	EnableGRPCMetrics: true,
}

bundle := prometheus.NewBundle(config)

app, err := framework.New(
	framework.WithConfig(&baseConfig),
	framework.WithBundle(bundle),
)

Custom Metrics ¶

Register and use custom metrics:

// Get metrics registry
registry := bundle.Registry()

// Create custom counter
userCreated := prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Namespace: "myservice",
		Name:      "users_created_total",
		Help:      "Total number of users created",
	},
	[]string{"source"},
)
registry.MustRegister(userCreated)

// Use in your code
userCreated.WithLabelValues("api").Inc()

Automatic Metrics ¶

The bundle automatically collects:

• HTTP request metrics (duration, count, status codes)
• gRPC call metrics (duration, count, status codes)
• Health check metrics (success/failure, duration)
• Database connection pool metrics
• Redis connection pool metrics
• JWT authentication metrics
• Circuit breaker state metrics

Integration with Other Bundles ¶

The Prometheus bundle automatically integrates with:

• PostgreSQL bundle for database metrics
• Redis bundle for cache and connection metrics
• JWT bundle for authentication metrics
• HTTP client bundle for request metrics

Grafana Integration ¶

The bundle provides pre-built Grafana dashboards for:

• Application overview and health
• HTTP and gRPC request monitoring
• Database and cache performance
• Error rates and SLA monitoring