Compare commits

...

10 Commits

Author SHA1 Message Date
a5abbbec1f move recorder to interface
All checks were successful
Build and Publish / check-chart (push) Successful in 36s
Build and Publish / helm-release (push) Has been skipped
Build and Publish / release (push) Successful in 3m8s
2025-03-21 15:54:28 -04:00
e9b70fe6e0 update gitea ci
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / check-chart (push) Successful in 20s
Build and Publish / helm-release (push) Has been skipped
2025-03-21 13:17:03 -04:00
ca18eba167 update gitea ci
All checks were successful
Build and Publish / chart-updated (push) Successful in 40s
Build and Publish / helm-release (push) Successful in 18s
Build and Publish / release (push) Successful in 3m4s
2025-03-21 13:14:45 -04:00
c020c4eec8 update gitea ci
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / chart-updated (push) Successful in 10s
Build and Publish / helm-release (push) Successful in 18s
2025-03-21 13:12:39 -04:00
df7c2dff40 update gitea ci
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / chart-updated (push) Successful in 10s
Build and Publish / helm-release (push) Has been skipped
2025-03-21 13:09:47 -04:00
0b27285b86 update gitea ci
Some checks failed
Build and Publish / release (push) Has been skipped
Build and Publish / chart-updated (push) Failing after 18s
Build and Publish / helm-release (push) Has been skipped
2025-03-21 13:08:08 -04:00
1f097b1fd7 fix recorder 2025-03-21 12:52:39 -04:00
42eea2346b refactor state to recorder, finish implementing 2025-03-21 09:22:32 -04:00
a5948cf334 bump helm chart
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / helm-release (push) Successful in 17s
2025-03-20 17:04:35 -04:00
deb831a2c5 bump helm chart
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / helm-release (push) Has been skipped
2025-03-20 16:50:06 -04:00
18 changed files with 417 additions and 228 deletions

View File

@ -2,6 +2,7 @@ name: Build and Publish
on: on:
push: push:
tags: ["v*"] tags: ["v*"]
branches: ["main"]
env: env:
PACKAGE_NAME: ambient-local-exporter PACKAGE_NAME: ambient-local-exporter
@ -21,9 +22,10 @@ env:
jobs: jobs:
release: release:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v') # Only run on tag push
steps: steps:
- name: Checkout Code - name: Checkout Code
uses: actions/checkout@v3 uses: actions/checkout@v4
- name: Set up Go Environment - name: Set up Go Environment
uses: actions/setup-go@v4 uses: actions/setup-go@v4
@ -87,12 +89,29 @@ jobs:
VER_PKG=${{ env.VER_PKG }} VER_PKG=${{ env.VER_PKG }}
VERSION=${{ github.ref_name }} VERSION=${{ github.ref_name }}
# Detect if the helm chart was updated
check-chart:
runs-on: ubuntu-latest
outputs:
chart-updated: ${{ steps.filter.outputs.chart }}
steps:
- uses: actions/checkout@v4
- name: Check Chart Changed
uses: dorny/paths-filter@v3
id: filter
with:
base: ${{ github.ref }}
filters: |
chart:
- helm/ambient-local-exporter/Chart.yaml
helm-release: helm-release:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: release needs: check-chart
if: ${{ needs.check-chart.outputs.chart-updated == 'true' }}
steps: steps:
- name: Checkout Code - name: Checkout Code
uses: actions/checkout@v3 uses: actions/checkout@v4
- name: Install Helm - name: Install Helm
env: env:
@ -102,7 +121,7 @@ jobs:
- name: Package Chart - name: Package Chart
run: | run: |
helm package --app-version ${VERSION#v} ${CHART_DIR} helm package --app-version ${VERSION} ${CHART_DIR}
- name: Publish Chart - name: Publish Chart
env: env:

View File

@ -3,7 +3,8 @@ services:
ambient-local-exporter: ambient-local-exporter:
build: . build: .
ports: ports:
- 8080:8080 - 8080:8080 # HTTP
- 8081:8081 # GRPC
volumes: volumes:
- ./config.yaml:/app/config.yaml - ./config.yaml:/app/config.yaml
command: command:

View File

@ -15,13 +15,13 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes # This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version. # to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/) # Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0 version: 0.1.2
# This is the version number of the application being deployed. This version number should be # This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to # incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using. # follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes. # It is recommended to use it with quotes.
appVersion: "v0.10.1" appVersion: "v0.10.2"
dependencies: dependencies:
- name: hull - name: hull

14
main.go
View File

@ -9,19 +9,16 @@ import (
grpcopts "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/grpc/opts" grpcopts "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/grpc/opts"
httpopts "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts" httpopts "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts"
"golang.org/x/sys/unix" "golang.org/x/sys/unix"
"k8s.io/utils/ptr"
weatherpb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather" weatherpb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient/ambienthttp" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient/ambienthttp"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient/config" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/ambient/config"
weathergrpc "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/grpc" weathergrpc "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/grpc"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/state"
) )
const ( const (
defaultMetricPrefix = "weather" defaultMetricPrefix = "weather"
defaultUpdatesToKeep = 120
) )
func main() { func main() {
@ -48,11 +45,6 @@ func main() {
} }
func prepareApp(ctx context.Context, aw *ambient.AmbientWeather) *app.App { func prepareApp(ctx context.Context, aw *ambient.AmbientWeather) *app.App {
// Config updates / defaults
if aw.Config.UpdatesToKeep == nil || *aw.Config.UpdatesToKeep < 1 {
aw.Config.UpdatesToKeep = ptr.To(defaultUpdatesToKeep)
}
// Load ambient routes into app // Load ambient routes into app
awApp := &app.App{ awApp := &app.App{
AppContext: ctx, AppContext: ctx,
@ -90,11 +82,7 @@ func prepareApp(ctx context.Context, aw *ambient.AmbientWeather) *app.App {
{ {
Name: "Weather Service", Name: "Weather Service",
Type: &weatherpb.AmbientLocalWeatherService_ServiceDesc, Type: &weatherpb.AmbientLocalWeatherService_ServiceDesc,
Service: weathergrpc.NewGRPCWeather(ctx, state.NewWeatherState( Service: weathergrpc.NewGRPCWeather(ctx, aw.GetRecorder()),
&state.Opts{
Ctx: ctx,
KeepLast: *aw.Config.UpdatesToKeep,
})),
}, },
}, },
}, },

View File

@ -20,8 +20,11 @@ import (
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/provider/awn" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/provider/awn"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/provider/wunderground" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/provider/wunderground"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/recorder"
) )
const defUpdatesToKeep = 120
type AmbientWeather struct { type AmbientWeather struct {
// These providers implement support for the update sent // These providers implement support for the update sent
// when either "AmbientWeather" or "Wunderground" are selected // when either "AmbientWeather" or "Wunderground" are selected
@ -30,25 +33,51 @@ type AmbientWeather struct {
Config *config.AmbientLocalExporterConfig Config *config.AmbientLocalExporterConfig
awnProvider provider.AmbientProvider awnProvider provider.AmbientProvider
wuProvider provider.AmbientProvider wuProvider provider.AmbientProvider
weatherRecorder *recorder.WeatherRecorder
appCtx context.Context appCtx context.Context
metrics *weather.WeatherMetrics metrics *weather.WeatherMetrics
l *zerolog.Logger l *zerolog.Logger
*sync.RWMutex
} }
func New(appCtx context.Context, awConfig *config.AmbientLocalExporterConfig) *AmbientWeather { func New(appCtx context.Context, awConfig *config.AmbientLocalExporterConfig) *AmbientWeather {
return &AmbientWeather{ return &AmbientWeather{
Config: awConfig, Config: awConfig,
appCtx: appCtx, appCtx: appCtx,
RWMutex: &sync.RWMutex{},
} }
} }
// Initialize with defaults, set logger from context // Initialize with defaults, set logger from context
func (aw *AmbientWeather) Init() *AmbientWeather { func (aw *AmbientWeather) Init() *AmbientWeather {
tracer := otel.GetTracer(aw.appCtx, "ambientWeather")
_, span := tracer.Start(aw.appCtx, "ambientWeather.init",
trace.WithAttributes(
attribute.String("name", aw.Config.Name),
attribute.Bool("grpcEnabled", aw.Config.GRPCEnabled()),
attribute.Bool("httpEnabled", aw.Config.HTTPEnabled()),
attribute.Int("weatherStations", len(aw.Config.WeatherStations)),
))
defer span.End()
aw.awnProvider = &awn.AWNProvider{} aw.awnProvider = &awn.AWNProvider{}
aw.wuProvider = &wunderground.WUProvider{} aw.wuProvider = &wunderground.WUProvider{}
aw.l = zerolog.Ctx(aw.appCtx) aw.l = zerolog.Ctx(aw.appCtx)
updatesToKeep := defUpdatesToKeep
if aw.Config.UpdatesToKeep != nil && *aw.Config.UpdatesToKeep > 0 {
updatesToKeep = *aw.Config.UpdatesToKeep
}
span.SetAttributes(attribute.Int("updatesToKeep", updatesToKeep))
// TODO: Support other recorders (don't rely on default)
aw.weatherRecorder = recorder.NewWeatherRecorder(&recorder.Opts{
Ctx: aw.appCtx,
KeepLast: updatesToKeep,
})
aw.l.Trace().Any("awConfig", aw.Config).Send() aw.l.Trace().Any("awConfig", aw.Config).Send()
span.SetStatus(codes.Ok, "")
return aw return aw
} }
@ -78,6 +107,9 @@ func (aw *AmbientWeather) handleProviderRequest(
w http.ResponseWriter, w http.ResponseWriter,
r *http.Request, r *http.Request,
) { ) {
aw.Lock()
defer aw.Unlock()
l := zerolog.Ctx(aw.appCtx) l := zerolog.Ctx(aw.appCtx)
tracer := otel.GetTracer(aw.appCtx, p.Name()+".http.handler") tracer := otel.GetTracer(aw.appCtx, p.Name()+".http.handler")
@ -110,6 +142,9 @@ func (aw *AmbientWeather) handleProviderRequest(
updateSpan.SetAttributes(attribute.String("stationName", update.StationConfig.Name)) updateSpan.SetAttributes(attribute.String("stationName", update.StationConfig.Name))
} }
// Record state
aw.weatherRecorder.Set(ctx, update)
// Update metrics // Update metrics
aw.metricsUpdate(ctx, p, update) aw.metricsUpdate(ctx, p, update)
@ -242,3 +277,10 @@ func (aw *AmbientWeather) enrichStation(update *weather.WeatherUpdate) {
} }
} }
} }
func (aw *AmbientWeather) GetRecorder() *recorder.WeatherRecorder {
aw.RLock()
defer aw.RUnlock()
return aw.weatherRecorder
}

17
pkg/util/util.go Normal file
View File

@ -0,0 +1,17 @@
package util
import "k8s.io/utils/ptr"
func DerefStr(s *string) string {
if s == nil {
return ""
}
return *s
}
func Int32ptr(i *int) *int32 {
if i == nil {
return nil
}
return ptr.To(int32(*i))
}

View File

@ -1,9 +1,8 @@
package grpc package grpc
import ( import (
"k8s.io/utils/ptr"
pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather" pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/util"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
) )
@ -18,18 +17,18 @@ func UpdatesToPbUpdates(u []*weather.WeatherUpdate) []*pb.WeatherUpdate {
func UpdateToPbUpdate(u *weather.WeatherUpdate) *pb.WeatherUpdate { func UpdateToPbUpdate(u *weather.WeatherUpdate) *pb.WeatherUpdate {
return &pb.WeatherUpdate{ return &pb.WeatherUpdate{
StationName: u.StationConfig.Name, StationName: u.StationConfig.Name,
StationType: derefStr(u.StationType), StationType: util.DerefStr(u.StationType),
StationId: derefStr(u.StationID), StationId: util.DerefStr(u.StationID),
TempOutdoorF: u.TempOutdoorF, TempOutdoorF: u.TempOutdoorF,
TempIndoorF: u.TempIndoorF, TempIndoorF: u.TempIndoorF,
HumidityOutdoor: int32ptr(u.HumidityOudoor), HumidityOutdoor: util.Int32ptr(u.HumidityOudoor),
HumidityIndoor: int32ptr(u.HumidityIndoor), HumidityIndoor: util.Int32ptr(u.HumidityIndoor),
WindSpeedMph: u.WindSpeedMPH, WindSpeedMph: u.WindSpeedMPH,
WindGustMph: u.WindGustMPH, WindGustMph: u.WindGustMPH,
MaxDailyGust: u.MaxDailyGust, MaxDailyGust: u.MaxDailyGust,
WindDir: int32ptr(u.WindDir), WindDir: util.Int32ptr(u.WindDir),
WindDirAvg_10M: int32ptr(u.WindDirAvg10m), WindDirAvg_10M: util.Int32ptr(u.WindDirAvg10m),
Uv: int32ptr(u.UV), Uv: util.Int32ptr(u.UV),
SolarRadiation: u.SolarRadiation, SolarRadiation: u.SolarRadiation,
HourlyRainIn: u.HourlyRainIn, HourlyRainIn: u.HourlyRainIn,
EventRainIn: u.EventRainIn, EventRainIn: u.EventRainIn,
@ -52,7 +51,7 @@ func batteriesToPbBatteries(batteries []weather.BatteryStatus) []*pb.BatteryStat
for i, b := range batteries { for i, b := range batteries {
pbBatteries[i] = &pb.BatteryStatus{ pbBatteries[i] = &pb.BatteryStatus{
Component: b.Component, Component: b.Component,
Status: int32ptr(b.Status), Status: util.Int32ptr(b.Status),
} }
} }
return pbBatteries return pbBatteries
@ -64,22 +63,8 @@ func thSensorsToPbSensors(sensors []*weather.TempHumiditySensor) []*pb.TempHumid
pbSensors[i] = &pb.TempHumiditySensor{ pbSensors[i] = &pb.TempHumiditySensor{
Name: s.Name, Name: s.Name,
TempF: s.TempF, TempF: s.TempF,
Humidity: int32ptr(s.Humidity), Humidity: util.Int32ptr(s.Humidity),
} }
} }
return pbSensors return pbSensors
} }
func derefStr(s *string) string {
if s == nil {
return ""
}
return *s
}
func int32ptr(i *int) *int32 {
if i == nil {
return nil
}
return ptr.To(int32(*i))
}

View File

@ -13,20 +13,20 @@ import (
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/otel" "gitea.libretechconsulting.com/rmcguire/go-app/pkg/otel"
pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather" pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/state" "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/recorder"
) )
type GRPCWeather struct { type GRPCWeather struct {
ctx context.Context ctx context.Context
state *state.WeatherState recorder *recorder.WeatherRecorder
tracer trace.Tracer tracer trace.Tracer
*pb.UnimplementedAmbientLocalWeatherServiceServer *pb.UnimplementedAmbientLocalWeatherServiceServer
} }
func NewGRPCWeather(ctx context.Context, state *state.WeatherState) *GRPCWeather { func NewGRPCWeather(ctx context.Context, recorder *recorder.WeatherRecorder) *GRPCWeather {
return &GRPCWeather{ return &GRPCWeather{
ctx: ctx, ctx: ctx,
state: state, recorder: recorder,
tracer: otel.GetTracer(ctx, "grpcWeather"), tracer: otel.GetTracer(ctx, "grpcWeather"),
} }
} }
@ -46,7 +46,7 @@ func (w *GRPCWeather) GetWeather(ctx context.Context, req *pb.GetWeatherRequest)
span.SetAttributes(attribute.Int("limit", limit)) span.SetAttributes(attribute.Int("limit", limit))
updates, err := w.state.Get(ctx, limit) updates, err := w.recorder.Get(ctx, req)
if err != nil { if err != nil {
span.RecordError(err) span.RecordError(err)
span.SetStatus(otelcodes.Error, err.Error()) span.SetStatus(otelcodes.Error, err.Error())

View File

@ -0,0 +1,51 @@
package recorder
import (
"context"
"sync"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/otel"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/recorder/recorders"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/recorder/recorders/memory"
)
type WeatherRecorder struct {
recorder recorders.Recorder
ctx context.Context
tracer trace.Tracer
meter metric.Meter
*sync.RWMutex
}
type Opts struct {
Ctx context.Context
Recorder recorders.Recorder // If nil, will use memory recorder
KeepLast int
}
func NewWeatherRecorder(opts *Opts) *WeatherRecorder {
if opts.KeepLast < 1 {
opts.KeepLast = 1
}
if opts.Recorder == nil {
opts.Recorder = &memory.MemoryRecorder{}
}
opts.Recorder.Init(opts.Ctx, &recorders.RecorderOpts{
RetainLast: opts.KeepLast,
BaseCtx: opts.Ctx,
})
return &WeatherRecorder{
ctx: opts.Ctx,
recorder: opts.Recorder,
tracer: otel.GetTracer(opts.Ctx, "weatherRecorder"),
meter: otel.GetMeter(opts.Ctx, "weatherRecorder"),
RWMutex: &sync.RWMutex{},
}
}

View File

@ -0,0 +1,60 @@
package recorder
import (
"context"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"k8s.io/utils/ptr"
pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/util"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
// Returns last requested number of weather updates
// If negative number given, will return all weather observations
func (w *WeatherRecorder) Get(ctx context.Context, req *pb.GetWeatherRequest) (
[]*weather.WeatherUpdate, error,
) {
if req == nil {
req = &pb.GetWeatherRequest{Limit: ptr.To(int32(-1))}
}
if req.Limit == nil || *req.Limit < 0 {
req.Limit = ptr.To(int32(-1))
} else if *req.Limit == 0 {
req.Limit = ptr.To(int32(1))
}
ctx, span := w.tracer.Start(ctx, "getWeatherRecorder")
span.SetAttributes(
attribute.String("stationNameFilter", util.DerefStr(req.Opts.StationName)),
attribute.String("stationTypeFilter", util.DerefStr(req.Opts.StationType)),
attribute.Int("last", int(*req.Limit)),
attribute.Int("currentSize", w.Count(ctx)),
)
defer span.End()
updates, err := w.recorder.Get(ctx, req)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
} else {
span.SetStatus(codes.Ok, "")
}
return updates, err
}
// Returns count of retained weather updates
func (w *WeatherRecorder) Count(ctx context.Context) int {
ctx, span := w.tracer.Start(ctx, "countWeatherRecorder")
defer span.End()
count := w.recorder.Count(ctx)
span.SetAttributes(attribute.Int("count", count))
span.SetStatus(codes.Ok, "")
return count
}

View File

@ -0,0 +1,21 @@
package recorder
import (
"context"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/util"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
func (w *WeatherRecorder) Set(ctx context.Context, u *weather.WeatherUpdate) error {
ctx, span := w.tracer.Start(ctx, "setRecorderUpdate", trace.WithAttributes(
attribute.String("stationName", u.StationConfig.Name),
attribute.String("stationType", util.DerefStr(u.StationType)),
attribute.String("stationEquipment", u.StationConfig.Equipment),
))
defer span.End()
return w.recorder.Set(ctx, u)
}

View File

@ -0,0 +1,75 @@
package memory
import (
"context"
"errors"
"slices"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
func (r *MemoryRecorder) Get(ctx context.Context, req *pb.GetWeatherRequest) (
[]*weather.WeatherUpdate, error,
) {
ctx, span := r.tracer.Start(ctx, "memoryRecorder.Get")
defer span.End()
r.RLock()
defer r.RUnlock()
span.AddEvent("acquired lock on recorder cache")
updates := r.updates
if r.count() == 0 {
err := errors.New("no recorded updates to get")
span.RecordError(err)
return nil, err
} else if r.count() <= int(*req.Limit) {
span.RecordError(errors.New("requested more updates than recorded"))
}
// Filter by Station Name if requested
if req.Opts.StationName != nil && *req.Opts.StationName != "" {
updates = slices.DeleteFunc(updates, func(u *weather.WeatherUpdate) bool {
return u.StationConfig == nil || u.StationConfig.Name != *req.Opts.StationName
})
}
// Filter by Station Type if requested
if req.Opts.StationType != nil && *req.Opts.StationType != "" {
updates = slices.DeleteFunc(updates, func(u *weather.WeatherUpdate) bool {
return u.StationType == nil || *u.StationType != *req.Opts.StationType
})
}
// Limit results
if len(updates) > int(*req.Limit) {
updates = updates[len(updates)-int(*req.Limit):]
}
span.SetAttributes(attribute.Int("retrieved", len(updates)))
span.SetStatus(codes.Ok, "")
return updates, nil
}
func (r *MemoryRecorder) Count(ctx context.Context) int {
_, span := r.tracer.Start(ctx, "countWeatherRecorder")
defer span.End()
count := r.count()
span.SetAttributes(attribute.Int("count", count))
span.SetStatus(codes.Ok, "")
return count
}
func (r *MemoryRecorder) count() int {
return len(r.updates)
}

View File

@ -0,0 +1,35 @@
package memory
import (
"context"
"sync"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/otel"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather/recorder/recorders"
)
const defRetainLast = 120
type MemoryRecorder struct {
baseCtx context.Context
updates []*weather.WeatherUpdate
tracer trace.Tracer
keep int
*sync.RWMutex
}
func (r *MemoryRecorder) Init(ctx context.Context, opts *recorders.RecorderOpts) {
if opts.RetainLast < 1 {
opts.RetainLast = defRetainLast
}
r.updates = make([]*weather.WeatherUpdate, 0, opts.RetainLast)
r.keep = opts.RetainLast
r.baseCtx = opts.BaseCtx
r.RWMutex = &sync.RWMutex{}
r.tracer = otel.GetTracer(r.baseCtx, "memoryRecorder")
}

View File

@ -0,0 +1,38 @@
package memory
import (
"context"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
func (r *MemoryRecorder) Set(ctx context.Context, u *weather.WeatherUpdate) error {
r.Lock()
defer r.Unlock()
ctx, span := r.tracer.Start(ctx, "memoryRecorder.Set")
span.SetAttributes(
attribute.Int("countWeatherUpdates", r.Count(ctx)),
attribute.Int("keepUpdates", r.keep),
)
defer span.End()
return r.set(ctx, u)
}
func (r *MemoryRecorder) set(ctx context.Context, u *weather.WeatherUpdate) error {
span := trace.SpanFromContext(ctx)
if len(r.updates) > r.keep {
r.updates = r.updates[1:]
span.AddEvent("trimmed recorded updates by 1")
}
r.updates = append(r.updates, u)
span.AddEvent("recorded weather update")
return nil
}

View File

@ -0,0 +1,20 @@
package recorders
import (
"context"
pb "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
type RecorderOpts struct {
RetainLast int
BaseCtx context.Context
}
type Recorder interface {
Init(context.Context, *RecorderOpts)
Set(context.Context, *weather.WeatherUpdate) error
Get(context.Context, *pb.GetWeatherRequest) ([]*weather.WeatherUpdate, error)
Count(context.Context) int // Best Effort
}

View File

@ -1,41 +0,0 @@
package state
import (
"context"
"sync"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/otel"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
type WeatherState struct {
updates []*weather.WeatherUpdate
keep int
ctx context.Context
tracer trace.Tracer
meter metric.Meter
*sync.RWMutex
}
type Opts struct {
Ctx context.Context
KeepLast int
}
func NewWeatherState(opts *Opts) *WeatherState {
if opts.KeepLast < 1 {
opts.KeepLast = 1
}
return &WeatherState{
updates: make([]*weather.WeatherUpdate, 0),
keep: opts.KeepLast,
ctx: opts.Ctx,
tracer: otel.GetTracer(opts.Ctx, "weatherState"),
meter: otel.GetMeter(opts.Ctx, "weatherState"),
}
}

View File

@ -1,87 +0,0 @@
package state
import (
"context"
"errors"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
// Returns last requested number of weather updates
func (w *WeatherState) Get(ctx context.Context, last int) (
[]*weather.WeatherUpdate, error,
) {
if last < 1 {
last = 1
}
ctx, span := w.tracer.Start(ctx, "getWeatherState")
span.SetAttributes(
attribute.Int("last", last),
attribute.Int("keep", w.keep),
attribute.Int("currentSize", w.Count()),
)
defer span.End()
updates, err := w.get(ctx, last)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
} else {
span.SetStatus(codes.Ok, "")
}
return updates, err
}
func (w *WeatherState) get(ctx context.Context, last int) (
[]*weather.WeatherUpdate, error,
) {
span := trace.SpanFromContext(ctx)
w.RLock()
defer w.Unlock()
span.AddEvent("acquired lock on state cache")
updates := w.updates
if w.count() == 0 {
err := errors.New("no state to get")
span.RecordError(err)
return nil, err
} else if w.count() <= last {
span.RecordError(errors.New("requested more state than exists"))
} else {
updates = updates[len(updates)-last:]
}
span.SetAttributes(attribute.Int("retrieved", len(updates)))
span.SetStatus(codes.Ok, "")
return updates, nil
}
// Returns count of retained weather updates
func (w *WeatherState) Count() int {
_, span := w.tracer.Start(w.ctx, "countWeatherState")
defer span.End()
count := w.count()
span.SetAttributes(attribute.Int("count", count))
span.SetStatus(codes.Ok, "")
return count
}
func (w *WeatherState) count() int {
w.RLock()
defer w.RUnlock()
return len(w.updates)
}

View File

@ -1,35 +0,0 @@
package state
import (
"context"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/pkg/weather"
)
func (w *WeatherState) Set(ctx context.Context, u *weather.WeatherUpdate) error {
_, span := w.tracer.Start(ctx, "setWeatherState")
span.SetAttributes(
attribute.Int("countWeatherUpdates", w.Count()),
attribute.Int("keepUpdates", w.keep),
)
defer span.End()
return w.set(span, u)
}
func (w *WeatherState) set(span trace.Span, u *weather.WeatherUpdate) error {
w.Lock()
defer w.Unlock()
if len(w.updates) > w.keep {
w.updates = w.updates[1:]
span.AddEvent("trimmed state updates by 1")
}
w.updates = append(w.updates, u)
span.AddEvent("recorded weather state")
return nil
}