Configuration

MoniGo uses a builder pattern for configuration. All options are chained off monigo.NewBuilder() and finalized with .Build().

Full Builder Example

monigoInstance := monigo.NewBuilder().
    WithServiceName("data-api").        // Required - identifies your service
    WithPort(8080).                     // Dashboard port (default: 8080)
    WithRetentionPeriod("4d").          // How long to keep data points
    WithDataPointsSyncFrequency("5s").  // Sync interval
    WithSamplingRate(100).              // Profile 1 in N calls
    WithStorageType("memory").          // "memory" or "disk"
    WithHeadless(false).                // true = no dashboard UI
    Build()

Option Reference

Method	Default	Description
`WithServiceName(name)`	required	Name shown in the dashboard
`WithPort(port)`	`8080`	HTTP port for the dashboard
`WithRetentionPeriod(dur)`	`"7d"`	Data retention period (e.g. `"4d"`, `"12h"`)
`WithDataPointsSyncFrequency(dur)`	`"5s"`	How often metrics are flushed to storage
`WithSamplingRate(n)`	`100`	Capture heavy profiles every n-th call
`WithStorageType(t)`	`"disk"`	`"memory"` (volatile) or `"disk"` (persistent via tstorage)
`WithHeadless(b)`	`false`	Run without the dashboard UI
`WithTimeZone(tz)`	`"Local"`	Timezone for timestamps
`WithCustomBaseAPIPath(p)`	`"/monigo/api/v1"`	Custom base path for API endpoints
`WithMaxCPUUsage(pct)`	`95.0`	Health threshold for CPU usage (%)
`WithMaxMemoryUsage(pct)`	`95.0`	Health threshold for memory usage (%)
`WithMaxGoRoutines(n)`	`100`	Health threshold for goroutine count
`WithOTelEndpoint(endpoint)`	-	OTLP gRPC endpoint for metric export
`WithOTelHeaders(headers)`	-	Auth headers for OTel exporter
`WithLogLevel(level)`	`slog.LevelInfo`	Structured log level (`log/slog`)
`WithLogger(logger)`	-	Custom `*slog.Logger` instance
`WithDashboardMiddleware(mw...)`	-	HTTP middleware chain for dashboard routes
`WithAPIMiddleware(mw...)`	-	HTTP middleware chain for API routes
`WithAuthFunction(fn)`	-	Custom auth function `func(*http.Request) bool`

Health Thresholds

Configure custom thresholds for your application’s resource usage alerts:

monigoInstance := monigo.NewBuilder().
    WithServiceName("my-service").
    WithMaxCPUUsage(90).        // Alert when CPU > 90%
    WithMaxMemoryUsage(90).     // Alert when memory > 90%
    WithMaxGoRoutines(500).     // Alert when goroutines > 500
    Build()

OpenTelemetry Integration

Send metrics to any OTel Collector:

monigoInstance := monigo.NewBuilder().
    WithServiceName("my-service").
    WithOTelEndpoint("localhost:4317").
    WithOTelHeaders(map[string]string{
        "Authorization": "Bearer <token>",
    }).
    Build()

Custom Logger

MoniGo uses log/slog internally. You can control the log level or bring your own logger:

monigoInstance := monigo.NewBuilder().
    WithServiceName("my-service").
    WithLogLevel(slog.LevelDebug).
    // Or bring your own:
    // WithLogger(myCustomSlogLogger).
    Build()