Support metric prefix change

TODO.md

@@ -7,6 +7,7 @@
 - [ ] Add device name field with ID/Key mappings
 - [ ] Add device type field with ID/Key mappings
 - [ ] Move EVERYTHING to pointers to support nil
+- [ ] Add proxy to upstream support
 
 ## Done
 - [x] Consolidate battery status into one metric with device label

go.mod

@@ -3,7 +3,7 @@ module gitea.libretechconsulting.com/rmcguire/ambient-weather-local-exporter
 go 1.23.4
 
 require (
-	gitea.libretechconsulting.com/rmcguire/go-app v0.3.0
+	gitea.libretechconsulting.com/rmcguire/go-app v0.3.1
 	github.com/gorilla/schema v1.4.1
 	github.com/rs/zerolog v1.33.0
 	go.opentelemetry.io/otel v1.33.0
@@ -40,12 +40,12 @@ require (
 	go.opentelemetry.io/otel/sdk v1.33.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v1.33.0 // indirect
 	go.opentelemetry.io/otel/trace v1.33.0 // indirect
-	go.opentelemetry.io/proto/otlp v1.4.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.5.0 // indirect
-	golang.org/x/net v0.33.0 // indirect
+	golang.org/x/net v0.34.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
-	google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20250106144421-5f5ef82da422 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250106144421-5f5ef82da422 // indirect
 	google.golang.org/grpc v1.69.2 // indirect
-	google.golang.org/protobuf v1.36.1 // indirect
+	google.golang.org/protobuf v1.36.2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,9 +1,7 @@
-gitea.libretechconsulting.com/rmcguire/go-app v0.1.3 h1:EwmEJLpN+rQjJ5stGEkZsqEDa5F/YnDAEeqJB9XlFn4=
-gitea.libretechconsulting.com/rmcguire/go-app v0.1.3/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
-gitea.libretechconsulting.com/rmcguire/go-app v0.2.0 h1:pOm/PysC0IWPuEbmEjNSHHa8Qc5OhuoksYExcuJMFE4=
-gitea.libretechconsulting.com/rmcguire/go-app v0.2.0/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
 gitea.libretechconsulting.com/rmcguire/go-app v0.3.0 h1:TSR6oEDBX+83975gmgGgU/cTFgfG999+9N/1h4RAXq0=
 gitea.libretechconsulting.com/rmcguire/go-app v0.3.0/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
+gitea.libretechconsulting.com/rmcguire/go-app v0.3.1 h1:jydcJ+Vv8sk+Le7nTI2+b6E7FfV+ShBJo7YdxmdaCYc=
+gitea.libretechconsulting.com/rmcguire/go-app v0.3.1/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
@@ -95,10 +93,14 @@ go.opentelemetry.io/otel/trace v1.33.0 h1:cCJuF7LRjUFso9LPnEAHJDB2pqzp+hbO8eu1qq
 go.opentelemetry.io/otel/trace v1.33.0/go.mod h1:uIcdVUZMpTAmz0tI1z04GoVSezK37CbGV4fr1f2nBck=
 go.opentelemetry.io/proto/otlp v1.4.0 h1:TA9WRvW6zMwP+Ssb6fLoUIuirti1gGbP28GcKG1jgeg=
 go.opentelemetry.io/proto/otlp v1.4.0/go.mod h1:PPBWZIP98o2ElSqI35IHfu7hIhSwvc5N38Jw8pXuGFY=
+go.opentelemetry.io/proto/otlp v1.5.0 h1:xJvq7gMzB31/d406fB8U5CBdyQGw4P399D1aQWU/3i4=
+go.opentelemetry.io/proto/otlp v1.5.0/go.mod h1:keN8WnHxOy8PG0rQZjJJ5A2ebUoafqWp0eVQ4yIXvJ4=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
 golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
+golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0=
+golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
@@ -108,12 +110,18 @@ golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
 golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
 google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d h1:H8tOf8XM88HvKqLTxe755haY6r1fqqzLbEnfrmLXlSA=
 google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d/go.mod h1:2v7Z7gP2ZUOGsaFyxATQSRoBnKygqVq2Cwnvom7QiqY=
+google.golang.org/genproto/googleapis/api v0.0.0-20250106144421-5f5ef82da422 h1:GVIKPyP/kLIyVOgOnTwFOrvQaQUzOzGMCxgFUOEmm24=
+google.golang.org/genproto/googleapis/api v0.0.0-20250106144421-5f5ef82da422/go.mod h1:b6h1vNKhxaSoEI+5jc3PJUCustfli/mRab7295pY7rw=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d h1:xJJRGY7TJcvIlpSrN3K6LAWgNFUILlO+OMAqtg9aqnw=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d/go.mod h1:3ENsm/5D1mzDyhpzeRi1NR784I0BcofWBoSc5QqqMK4=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250106144421-5f5ef82da422 h1:3UsHvIr4Wc2aW4brOaSCmcxh9ksica6fHEr8P1XhkYw=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250106144421-5f5ef82da422/go.mod h1:3ENsm/5D1mzDyhpzeRi1NR784I0BcofWBoSc5QqqMK4=
 google.golang.org/grpc v1.69.2 h1:U3S9QEtbXC0bYNvRtcoklF3xGtLViumSYxWykJS+7AU=
 google.golang.org/grpc v1.69.2/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
 google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
 google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
+google.golang.org/protobuf v1.36.2 h1:R8FeyR1/eLmkutZOM5CWghmo5itiG9z0ktFlTVLuTmU=
+google.golang.org/protobuf v1.36.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

main.go

@@ -12,15 +12,26 @@ import (
 	"gitea.libretechconsulting.com/rmcguire/ambient-weather-local-exporter/pkg/ambient"
 )
 
+const defaultMetricPrefix = "weather"
+
 func main() {
 	ctx, cncl := signal.NotifyContext(context.Background(), os.Kill, unix.SIGTERM)
 	defer cncl()
 
+	// Config type for app, which implements go-app/config.AppConfig
+	awConfig := &ambient.AmbientLocalExporterConfig{
+		MetricPrefix:    defaultMetricPrefix,
+		WeatherStations: make([]ambient.WeatherStation, 0),
+	}
+
 	// Read config and environment, set up logging, load up
 	// an appCtx, and prepare ambient weather local exporter
-	ctx = app.MustSetupConfigAndLogging(ctx)
+	ctx, awConfig = app.MustLoadConfigInto(ctx, awConfig)
-	aw := ambient.New(ctx).Init()
 
+	// Prepare the exporter
+	aw := ambient.New(ctx, awConfig).Init()
+
+	// Define and prepare the app
 	awApp := app.App{
 		AppContext: ctx,
 		HTTP: &app.AppHTTP{
@@ -43,7 +54,7 @@ func main() {
 		},
 	}
 
+	// Run and wait
 	awApp.MustRun()
-
 	<-awApp.Done()
 }

pkg/ambient/ambient.go

@@ -24,6 +24,7 @@ type AmbientWeather struct {
 	// when either "AmbientWeather" or "Wunderground" are selected
 	// in the "Custom" section of the AWNet app, or the web UI
 	// of an Ambient WeatherHub
+	config      *AmbientLocalExporterConfig
 	awnProvider provider.AmbientProvider
 	wuProvider  provider.AmbientProvider
 	appCtx      context.Context
@@ -31,7 +32,7 @@ type AmbientWeather struct {
 	l           *zerolog.Logger
 }
 
-func New(appCtx context.Context) *AmbientWeather {
+func New(appCtx context.Context, awConfig *AmbientLocalExporterConfig) *AmbientWeather {
 	return &AmbientWeather{
 		appCtx: appCtx,
 	}
@@ -96,6 +97,9 @@ func (aw *AmbientWeather) handleProviderRequest(
 
 	// Update metrics
 	if aw.metrics == nil {
+		if aw.config.MetricPrefix != "" {
+			weather.MetricPrefix = aw.config.MetricPrefix
+		}
 		aw.metrics = weather.MustInitMetrics(aw.appCtx)
 	}
 	aw.metrics.Update(update)

pkg/ambient/config.go

@@ -0,0 +1,33 @@
+package ambient
+
+import (
+	"gitea.libretechconsulting.com/rmcguire/go-app/pkg/config"
+
+	"gitea.libretechconsulting.com/rmcguire/ambient-weather-local-exporter/pkg/weather"
+)
+
+// This configuration includes all config from go-app/config.AppConfig
+type AmbientLocalExporterConfig struct {
+	MetricPrefix      string           `yaml:"metricPrefix" default:"weather" env:"AMBIENT_METRIC_PREFIX"`
+	WeatherStations   []WeatherStation `yaml:"weatherStations"` // No env, too complex, not worth the time
+	*config.AppConfig                  // Extends app config
+}
+
+type WeatherStation struct {
+	Name      string `yaml:"name"`      // Human Friendly Name (e.g. Back Yard Weather)
+	Equipment string `yaml:"equipment"` // Equipment Type (e.g. WS-5000)
+
+	// One of these is required, based on the type
+	// set in the "Custom" weather service on your
+	// console, weather station, or weather hub
+	WundergroundID string `yaml:"wundergroundID"`
+	AWNPassKey     string `yaml:"awnPassKey"`
+
+	// Proxy updates to AWN or Wunderground
+	ProxyToAWN          bool `yaml:"proxyToAWN"`
+	ProxyToWunderground bool `yaml:"proxyToWunderground"`
+
+	// Unreliable / unwanted metrics by name of WeatherUpdate Field
+	// These fields are mapped from the provider fields
+	DiscardMetrics []weather.WeatherUpdateField `yaml:"discardMetrics"`
+}

pkg/provider/awn/provider.go

@@ -43,7 +43,7 @@ func MapAwnUpdate(awnUpdate *AmbientWeatherUpdate) *weather.WeatherUpdate {
 		DateUTC:        &updateTime,
 		TempOutdoorF:   awnUpdate.TempF,
 		HumidityOudoor: awnUpdate.Humidity,
-		WindSpeedMPH:   awnUpdate.WindGustMPH,
+		WindSpeedMPH:   awnUpdate.WindSpeedMPH,
 		WindGustMPH:    awnUpdate.WindGustMPH,
 		MaxDailyGust:   awnUpdate.MaxDailyGust,
 		WindDir:        awnUpdate.WindDir,

pkg/weather/types.go

@@ -7,31 +7,27 @@ import (
 // Stable intermediate struct containing superset of fields
 // between AWN and Wunderground style updates from Ambient devices
 type WeatherUpdate struct {
-	DateUTC        *time.Time
+	DateUTC         *time.Time
-	StationType    string
+	StationType     string
-	TempOutdoorF   float64
+	TempOutdoorF    float64
-	TempIndoorF    float64
+	TempIndoorF     float64
-	HumidityOudoor int
+	HumidityOudoor  int
-	HumidityIndoor int
+	HumidityIndoor  int
-	WindSpeedMPH   float64
+	WindSpeedMPH    float64
-	WindGustMPH    float64
+	WindGustMPH     float64
-	MaxDailyGust   float64
+	MaxDailyGust    float64
-	WindDir        int
+	WindDir         int
-	WindDirAvg10m  int
+	WindDirAvg10m   int
-	UV             int
+	UV              int
-	SolarRadiation float64
+	SolarRadiation  float64
-	HourlyRainIn   float64
+	HourlyRainIn    float64
-	EventRainIn    float64
+	EventRainIn     float64
-	DailyRainIn    float64
+	DailyRainIn     float64
-	WeeklyRainIn   float64
+	WeeklyRainIn    float64
-	MonthlyRainIn  float64
+	MonthlyRainIn   float64
-	YearlyRainIn   float64
+	YearlyRainIn    float64
-	TotalRainIn    float64
+	TotalRainIn     float64
-	Batteries      []BatteryStatus
+	Batteries       []BatteryStatus
-	// BattOutdoorSensor int
-	// BattIndoorSensor  int
-	// BattRainSensor    int
-	// BattCO2Sensor     int
 	BaromRelativeIn float64
 	BaromAbsoluteIn float64
 	// These fields may be calculated
@@ -44,3 +40,35 @@ type BatteryStatus struct {
 	Component string
 	Status    int
 }
+
+type WeatherUpdateField string
+
+// NOTE: Annoyance to avoid string constant comparisons
+// CHORE: Maintain this
+const (
+	FieldDateUTC         WeatherUpdateField = "DateUTC"
+	FieldStationType     WeatherUpdateField = "StationType"
+	FieldTempOutdoorF    WeatherUpdateField = "TempOutdoorF"
+	FieldTempIndoorF     WeatherUpdateField = "TempIndoorF"
+	FieldHumidityOudoor  WeatherUpdateField = "HumidityOudoor"
+	FieldHumidityIndoor  WeatherUpdateField = "HumidityIndoor"
+	FieldWindSpeedMPH    WeatherUpdateField = "WindSpeedMPH"
+	FieldWindGustMPH     WeatherUpdateField = "WindGustMPH"
+	FieldMaxDailyGust    WeatherUpdateField = "MaxDailyGust"
+	FieldWindDir         WeatherUpdateField = "WindDir"
+	FieldWindDirAvg10m   WeatherUpdateField = "WindDirAvg10m"
+	FieldUV              WeatherUpdateField = "UV"
+	FieldSolarRadiation  WeatherUpdateField = "SolarRadiation"
+	FieldHourlyRainIn    WeatherUpdateField = "HourlyRainIn"
+	FieldEventRainIn     WeatherUpdateField = "EventRainIn"
+	FieldDailyRainIn     WeatherUpdateField = "DailyRainIn"
+	FieldWeeklyRainIn    WeatherUpdateField = "WeeklyRainIn"
+	FieldMonthlyRainIn   WeatherUpdateField = "MonthlyRainIn"
+	FieldYearlyRainIn    WeatherUpdateField = "YearlyRainIn"
+	FieldTotalRainIn     WeatherUpdateField = "TotalRainIn"
+	FieldBatteries       WeatherUpdateField = "Batteries"
+	FieldBaromRelativeIn WeatherUpdateField = "BaromRelativeIn"
+	FieldBaromAbsoluteIn WeatherUpdateField = "BaromAbsoluteIn"
+	FieldDewPointF       WeatherUpdateField = "DewPointF"
+	FieldWindChillF      WeatherUpdateField = "WindChillF"
+)