influxdb

Documentation

Index

• Constants
• func CreateWorkoutStatistics(workout *healthautoexport.Workout) healthautoexport.WorkoutFields
• func GetUnitizedMeasurementName(name string, metric WithUnits) string
• func NewBackend(client Client) (backends.Backend, error)
• func NewInfluxDBClient() (influxdb2.Client, error)
• type Backend
  • func (b *Backend) Name() string
  • func (b *Backend) Write(payload *healthautoexport.Payload, targetName string) error
• type Client
  • func NewClient() (Client, error)
• type MockClient
  • func NewMockClient() *MockClient
  • func (m *MockClient) ReadMetrics() []*write.Point
  • func (m *MockClient) ReadWorkouts() []*write.Point
  • func (m *MockClient) Reset()
  • func (m *MockClient) WriteMetrics(_ context.Context, point ...*write.Point) error
  • func (m *MockClient) WriteWorkouts(_ context.Context, point ...*write.Point) error
• type WithUnits

Constants

const (
	MeasurementSleepAnalysisDetailed   = "sleep_analysis_detailed"
	MeasurementSleepAnalysisAggregated = "sleep_analysis_aggregated"
	MeasurementSleepPhases             = "sleep_phases"
)

Functions

func CreateWorkoutStatistics

func CreateWorkoutStatistics(workout *healthautoexport.Workout) healthautoexport.WorkoutFields

CreateWorkoutStatistics returns additional fields for a Workout.

func GetUnitizedMeasurementName

func GetUnitizedMeasurementName(name string, metric WithUnits) string

GetUnitizedMeasurementName returns the measurement name. It will add a suffix for the unit to the measurement name.

func NewBackend

func NewBackend(client Client) (backends.Backend, error)

func NewInfluxDBClient

func NewInfluxDBClient() (influxdb2.Client, error)

Types

type Backend

type Backend struct {
	// contains filtered or unexported fields
}

Backend InfluxDB is used to store ingested metrics into InfluxDB. All metrics will be stored as single Points (i.e. time-series data).

func (*Backend) Name

func (b *Backend) Name() string

func (*Backend) Write

func (b *Backend) Write(payload *healthautoexport.Payload, targetName string) error

type Client

type Client interface {
	WriteMetrics(ctx context.Context, point ...*write.Point) error
	WriteWorkouts(ctx context.Context, point ...*write.Point) error
}

Client knows how to write to an InfluxDB database.

func NewClient

func NewClient() (Client, error)

NewClient returns a real influxdb Client initialized from flags.

type MockClient

type MockClient struct {
	// contains filtered or unexported fields
}

MockClient is a mock implementation of Client.

func NewMockClient

func NewMockClient() *MockClient

func (*MockClient) ReadMetrics

func (m *MockClient) ReadMetrics() []*write.Point

func (*MockClient) ReadWorkouts

func (m *MockClient) ReadWorkouts() []*write.Point

func (*MockClient) Reset

func (m *MockClient) Reset()

func (*MockClient) WriteMetrics

func (m *MockClient) WriteMetrics(_ context.Context, point ...*write.Point) error

func (*MockClient) WriteWorkouts

func (m *MockClient) WriteWorkouts(_ context.Context, point ...*write.Point) error

type WithUnits

type WithUnits interface {
	GetUnits() healthautoexport.Units
}