monitoring

package
v1.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 14, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package monitoring provides a portable monitoring API with cross-cutting concerns.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Monitoring 

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

Monitoring is the portable monitoring type wrapping a driver.

func NewMonitoring 

func NewMonitoring(d driver.Monitoring, opts ...Option) *Monitoring

func (*Monitoring) CreateAlarm 

func (m *Monitoring) CreateAlarm(ctx context.Context, config driver.AlarmConfig) error

func (*Monitoring) CreateNotificationChannel added in v1.4.0 

func (m *Monitoring) CreateNotificationChannel(
	ctx context.Context, cfg driver.NotificationChannelConfig,
) (*driver.NotificationChannelInfo, error)

CreateNotificationChannel creates a new notification channel.

func (*Monitoring) DeleteAlarm 

func (m *Monitoring) DeleteAlarm(ctx context.Context, name string) error

func (*Monitoring) DeleteNotificationChannel added in v1.4.0 

func (m *Monitoring) DeleteNotificationChannel(ctx context.Context, id string) error

DeleteNotificationChannel deletes a notification channel by ID.

func (*Monitoring) DescribeAlarms 

func (m *Monitoring) DescribeAlarms(ctx context.Context, names []string) ([]driver.AlarmInfo, error)

func (*Monitoring) GetAlarmHistory added in v1.4.0 

func (m *Monitoring) GetAlarmHistory(ctx context.Context, alarmName string, limit int) ([]driver.AlarmHistoryEntry, error)

GetAlarmHistory returns alarm history entries filtered by alarm name.

func (*Monitoring) GetMetricData 

func (m *Monitoring) GetMetricData(ctx context.Context, input driver.GetMetricInput) (*driver.MetricDataResult, error)

func (*Monitoring) GetNotificationChannel added in v1.4.0 

func (m *Monitoring) GetNotificationChannel(ctx context.Context, id string) (*driver.NotificationChannelInfo, error)

GetNotificationChannel returns a notification channel by ID.

func (*Monitoring) ListMetrics 

func (m *Monitoring) ListMetrics(ctx context.Context, namespace string) ([]string, error)

func (*Monitoring) ListNotificationChannels added in v1.4.0 

func (m *Monitoring) ListNotificationChannels(ctx context.Context) ([]driver.NotificationChannelInfo, error)

ListNotificationChannels returns all notification channels.

func (*Monitoring) PutMetricData 

func (m *Monitoring) PutMetricData(ctx context.Context, data []driver.MetricDatum) error

func (*Monitoring) SetAlarmState 

func (m *Monitoring) SetAlarmState(ctx context.Context, name, state, reason string) error

type Option 

type Option func(*Monitoring)

func WithErrorInjection 

func WithErrorInjection(i *inject.Injector) Option

func WithLatency 

func WithLatency(d time.Duration) Option

func WithMetrics 

func WithMetrics(mc *metrics.Collector) Option

func WithRateLimiter 

func WithRateLimiter(l *ratelimit.Limiter) Option

func WithRecorder 

func WithRecorder(r *recorder.Recorder) Option

Source Files

View all Source files

Directories

Path Synopsis
Package driver defines the interface for monitoring service implementations.
 Package driver defines the interface for monitoring service implementations.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.