api

Documentation

Index

• func GenerateRPCErr(logger log.Logger, e error) error
• func GetHeaderString(ctx context.Context, headerKey string) string
• func SupportedHeaders(cfg HeadersConfig) map[string]bool
• type AlertService
• type Config
• type Deps
• type HeadersConfig
• type NamespaceService
• type NotificationService
• type ProviderService
• type ReceiverService
• type RuleService
• type SilenceService
• type SubscriptionReceiverService
• type SubscriptionService
• type TemplateService

Functions

func GenerateRPCErr

func GenerateRPCErr(logger log.Logger, e error) error

func GetHeaderString

func GetHeaderString(ctx context.Context, headerKey string) string

func SupportedHeaders

func SupportedHeaders(cfg HeadersConfig) map[string]bool

Types

type AlertService

type AlertService interface {
	CreateAlerts(ctx context.Context, providerType string, providerID uint64, namespaceID uint64, body map[string]any) ([]alert.Alert, error)
	List(context.Context, alert.Filter) ([]alert.Alert, error)
}

type Config

type Config struct {
	UseGlobalSubscription bool
	WithDebugRequest      bool
}

type Deps

type Deps struct {
	TemplateService             TemplateService
	RuleService                 RuleService
	AlertService                AlertService
	ProviderService             ProviderService
	NamespaceService            NamespaceService
	ReceiverService             ReceiverService
	SubscriptionService         SubscriptionService
	SubscriptionReceiverService SubscriptionReceiverService
	NotificationService         NotificationService
	SilenceService              SilenceService
}

type HeadersConfig

type HeadersConfig struct {
	IdempotencyKey   string `mapstructure:"idempotency_key" yaml:"idempotency_key" default:"Idempotency-Key"`
	IdempotencyScope string `mapstructure:"idempotency_scope" yaml:"idempotency_scope" default:"Idempotency-Scope"`
}

type NamespaceService

type NamespaceService interface {
	List(context.Context) ([]namespace.Namespace, error)
	Create(context.Context, *namespace.Namespace) error
	Get(context.Context, uint64) (*namespace.Namespace, error)
	Update(context.Context, *namespace.Namespace) error
	Delete(context.Context, uint64) error
}

type NotificationService

type NotificationService interface {
	Dispatch(context.Context, []notification.Notification) ([]string, error)
	RemoveIdempotencies(ctx context.Context, TTL time.Duration) error
	CheckIdempotency(ctx context.Context, scope, key string) (string, error)
	InsertIdempotency(ctx context.Context, scope, key, notificationID string) error
	ListNotificationMessages(ctx context.Context, notificationID string) ([]notification.Message, error)
	List(ctx context.Context, flt notification.Filter) ([]notification.Notification, error)
}

type ProviderService

type ProviderService interface {
	List(context.Context, provider.Filter) ([]provider.Provider, error)
	Create(context.Context, *provider.Provider) error
	Get(context.Context, uint64) (*provider.Provider, error)
	Update(context.Context, *provider.Provider) error
	Delete(context.Context, uint64) error
}

type ReceiverService

type ReceiverService interface {
	List(ctx context.Context, flt receiver.Filter) ([]receiver.Receiver, error)
	Create(ctx context.Context, rcv *receiver.Receiver) error
	Get(ctx context.Context, id uint64, gopts ...receiver.GetOption) (*receiver.Receiver, error)
	Update(ctx context.Context, rcv *receiver.Receiver) error
	Delete(ctx context.Context, id uint64) error
}

type RuleService

type RuleService interface {
	Upsert(context.Context, *rule.Rule) error
	List(context.Context, rule.Filter) ([]rule.Rule, error)
}

type SilenceService

type SilenceService interface {
	Create(ctx context.Context, sil silence.Silence) (string, error)
	List(ctx context.Context, filter silence.Filter) ([]silence.Silence, error)
	Get(ctx context.Context, id string) (silence.Silence, error)
	Delete(ctx context.Context, id string) error
}

type SubscriptionReceiverService

type SubscriptionReceiverService interface {
	List(ctx context.Context, flt subscriptionreceiver.Filter) ([]subscriptionreceiver.Relation, error)
	BulkUpsert(ctx context.Context, rels []subscriptionreceiver.Relation) error
	Update(ctx context.Context, rel *subscriptionreceiver.Relation) error
	BulkSoftDelete(ctx context.Context, flt subscriptionreceiver.DeleteFilter) error
}

type SubscriptionService

type SubscriptionService interface {
	ListV2(context.Context, subscription.Filter) ([]subscription.Subscription, error)
	CreateV2(context.Context, *subscription.Subscription) error
	GetV2(context.Context, uint64) (*subscription.Subscription, error)
	UpdateV2(context.Context, *subscription.Subscription) error
	DeleteV2(context.Context, uint64) error
}

type TemplateService

type TemplateService interface {
	Upsert(context.Context, *template.Template) error
	List(context.Context, template.Filter) ([]template.Template, error)
	GetByName(context.Context, string) (*template.Template, error)
	Delete(context.Context, string) error
	Render(context.Context, string, map[string]string) (string, error)
}