unraid-management-agent: Command for GitHub Copilot

Add a New Collector

Follow these steps to add a new data collector to the Unraid Management Agent.

Step 1: Define the DTO

Create or update a struct in daemon/dto/ for the data this collector will produce.

• Use json:"field_name" tags on all exported fields
• Use json:"field_name,omitempty" for optional fields

Step 2: Create the Collector

Create a new file in daemon/services/collectors/ (e.g., myfeature.go).

Follow the pattern from system.go:

package collectors

import (
    "context"
    "time"

    "unraid-management-agent/daemon/domain"
    "unraid-management-agent/daemon/dto"
    "unraid-management-agent/daemon/logger"
)

type MyFeatureCollector struct {
    ctx *domain.Context
}

func NewMyFeatureCollector(ctx *domain.Context) *MyFeatureCollector {
    return &MyFeatureCollector{ctx: ctx}
}

func (c *MyFeatureCollector) Collect() {
    // Collect data from system sources
    data := dto.MyFeatureInfo{
        // populate fields
    }
    c.ctx.Hub.Pub(data, "my_feature_update")
}

func (c *MyFeatureCollector) Start(ctx context.Context, interval time.Duration) {
    func() {
        defer func() {
            if r := recover(); r != nil {
                logger.Error("MyFeature collector PANIC on startup: %v", r)
            }
        }()
        c.Collect()
    }()

    ticker := time.NewTicker(interval)
    defer ticker.Stop()
    for {
        select {
        case <-ctx.Done():
            return
        case <-ticker.C:
            func() {
                defer func() {
                    if r := recover(); r != nil {
                        logger.Error("MyFeature collector PANIC in loop: %v", r)
                    }
                }()
                c.Collect()
            }()
        }
    }
}

Step 3: Define the Interval

Add a constant in daemon/constants/const.go for the collection interval. Choose an appropriate interval considering CPU/power impact.

Step 4: Register the Collector

In daemon/services/collector_manager.go RegisterAllCollectors(), register the new collector.