shimesaba

Jul 19, 2022

Changes in this version

type Alert

+ func NewVirtualAlert(description string, openedAt time.Time, closedAt time.Time) *Alert

+ func (alert *Alert) IsVirtual() bool

type DataProvider

+ FetchVirtualAlerts func(ctx context.Context, serviceName string, sloID string, startAt time.Time, ...) (Alerts, error)

type MackerelClient

+ FindGraphAnnotations func(service string, from int64, to int64) ([]mackerel.GraphAnnotation, error)

type Repository

+ func (repo *Repository) FetchVirtualAlerts(ctx context.Context, serviceName string, sloID string, startAt time.Time, ...) (Alerts, error)

May 24, 2022

Changes in this version

+ func DestinationMetricTypeStrings() []string

type Destination

+ MetricTypeEnabled map[DestinationMetricType]bool

+ MetricTypeNames map[DestinationMetricType]string

+ func NewDestination(cfg *DestinationConfig) *Destination

+ func (d *Destination) MetricEnabled(metricType DestinationMetricType) bool

+ func (d *Destination) MetricName(metricType DestinationMetricType) string

type DestinationConfig

+ Metrics map[string]*DestinationMetricConfig

+ type DestinationMetricConfig struct

+ Enabled *bool

+ MetricTypeName string

+ func (c *DestinationMetricConfig) Merge(o *DestinationMetricConfig) *DestinationMetricConfig

+ func (c *DestinationMetricConfig) Restrict(t DestinationMetricType) error

+ type DestinationMetricType int

+ const ErrorBudget

+ const ErrorBudgetConsumption

+ const ErrorBudgetConsumptionPercentage

+ const ErrorBudgetPercentage

+ const ErrorBudgetRemainingPercentage

+ const FailureTime

+ const UpTime

+ func DestinationMetricTypeString(s string) (DestinationMetricType, error)

+ func DestinationMetricTypeValues() []DestinationMetricType

+ func (i *DestinationMetricType) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (i DestinationMetricType) IsADestinationMetricType() bool

+ func (i DestinationMetricType) MarshalYAML() (interface{}, error)

+ func (i DestinationMetricType) String() string

+ func (t DestinationMetricType) DefaultEnabled() bool

+ func (t DestinationMetricType) DefaultTypeName() string

+ func (t DestinationMetricType) ID() string

type Report

+ func (r *Report) GetDestinationMetricValue(metricType DestinationMetricType) float64

type SLOConfig

+ func (c *SLOConfig) ErrorBudgetSizePercentage() float64

Apr 19, 2022

Changes in this version

+ func DumpReportsOption(dump bool) func(*Options)

+ type AlertBasedSLI struct

+ func NewAlertBasedSLI(cfg *AlertBasedSLIConfig) *AlertBasedSLI

+ func (o AlertBasedSLI) EvaluateReliabilities(timeFrame time.Duration, alerts Alerts, startAt, endAt time.Time) (Reliabilities, error)

+ func (o AlertBasedSLI) MatchMonitor(monitor *Monitor) bool

+ type AlertBasedSLIConfig struct

+ MonitorID string

+ MonitorName string

+ MonitorNamePrefix string

+ MonitorNameSuffix string

+ MonitorType string

+ TryReassessment bool

+ func (c *AlertBasedSLIConfig) Restrict() error

type App

+ SLODefinitions []*Definition

type Config

+ SLO []*SLOConfig

+ type DataProvider interface

+ FetchAlerts func(ctx context.Context, startAt time.Time, endAt time.Time) (Alerts, error)

type Definition

+ func (d *Definition) AlertBasedSLIs(monitors []*Monitor) []*Monitor

+ func (d *Definition) CreateReportsWithAlertsAndPeriod(ctx context.Context, alerts Alerts, startAt, endAt time.Time) ([]*Report, error)

+ func (d *Definition) StartAt(now time.Time, backfill int) time.Time

+ type DestinationConfig struct

+ MetricPrefix string

+ MetricSuffix string

+ ServiceName string

+ func (c *DestinationConfig) Merge(o *DestinationConfig) *DestinationConfig

+ func (c *DestinationConfig) Restrict(sloID string) error

+ type SLOConfig struct

+ AlertBasedSLI []*AlertBasedSLIConfig

+ CalculateInterval string

+ Destination *DestinationConfig

+ ErrorBudgetSize interface{}

+ ID string

+ RollingPeriod string

+ func (c *SLOConfig) DurationCalculate() time.Duration

+ func (c *SLOConfig) DurationRollingPeriod() time.Duration

+ func (c *SLOConfig) ErrorBudgetSizeParcentage() float64

+ func (c *SLOConfig) Merge(o *SLOConfig) *SLOConfig

+ func (c *SLOConfig) Restrict() error

Jan 31, 2022

Changes in this version

type Alert

+ HostID string

+ Reason string

+ func (alert *Alert) CorrectionTime() (time.Duration, bool)

+ func (alert *Alert) EvaluateReliabilities(timeFrame time.Duration) (Reliabilities, error)

+ func (alert *Alert) WithHostID(hostID string) *Alert

+ func (alert *Alert) WithReason(reason string) *Alert

type AlertObjective

+ func (o AlertObjective) EvaluateReliabilities(timeFrame time.Duration, alerts Alerts, startAt, endAt time.Time) (Reliabilities, error)

type ExprObjective

+ func (o *ExprObjective) EvaluateReliabilities(timeFrame time.Duration, metrics Metrics, startAt, endAt time.Time) (Reliabilities, error)

type IsNoViolationCollection

+ func (c IsNoViolationCollection) NewReliabilities(timeFrame time.Duration, startAt, endAt time.Time) (Reliabilities, error)

type MackerelClient

+ GetOrg func() (*mackerel.Org, error)

type Monitor

+ func NewMonitor(id, name, monitorType string) *Monitor

+ func (m *Monitor) EvaluateReliabilities(hostID string, timeFrame time.Duration, startAt, endAt time.Time) (Reliabilities, bool)

+ func (m *Monitor) WithEvaluator(...) *Monitor

+ type Reliabilities []*Reliability

+ func NewReliabilities(s []*Reliability) (Reliabilities, error)

+ func (c Reliabilities) CalcTime(cursor, n int) (upTime, failureTime, deltaFailureTime time.Duration)

+ func (c Reliabilities) Clone() Reliabilities

+ func (c Reliabilities) CursorAt(i int) time.Time

+ func (c Reliabilities) Len() int

+ func (c Reliabilities) Less(i, j int) bool

+ func (c Reliabilities) Merge(other Reliabilities) (Reliabilities, error)

+ func (c Reliabilities) MergeInRange(other Reliabilities, startAt, endAt time.Time) (Reliabilities, error)

+ func (c Reliabilities) Swap(i, j int)

+ func (c Reliabilities) TimeFrame() time.Duration

type Repository

+ func (repo *Repository) GetOrgName(ctx context.Context) (string, error)

Jan 19, 2022

Changes in this version

+ type DryRunMackerelClient struct

+ func (c DryRunMackerelClient) CreateDashboard(param *mackerel.Dashboard) (*mackerel.Dashboard, error)

+ func (c DryRunMackerelClient) PostServiceMetricValues(serviceName string, metricValues []*mackerel.MetricValue) error

+ func (c DryRunMackerelClient) UpdateDashboard(dashboardID string, param *mackerel.Dashboard) (*mackerel.Dashboard, error)

type Repository

+ func (repo *Repository) WithDryRun() *Repository

Jan 17, 2022

Changes in this version

+ type Alert struct

+ ClosedAt *time.Time

+ Monitor *Monitor

+ OpenedAt time.Time

+ func NewAlert(monitor *Monitor, openedAt time.Time, closedAt *time.Time) *Alert

+ func (alert *Alert) String() string

+ type AlertObjective struct

+ func NewAlertObjective(cfg *AlertObjectiveConfig) *AlertObjective

+ func (o AlertObjective) MatchMonitor(monitor *Monitor) bool

+ func (o AlertObjective) NewReliabilityCollection(timeFrame time.Duration, alerts Alerts, startAt, endAt time.Time) (ReliabilityCollection, error)

+ type AlertObjectiveConfig struct

+ MonitorID string

+ MonitorNamePrefix string

+ MonitorNameSuffix string

+ MonitorType string

+ func (c *AlertObjectiveConfig) Restrict() error

+ type Alerts []*Alert

+ func (alerts Alerts) EndAt() time.Time

+ func (alerts Alerts) StartAt() time.Time

type Config

+ CalculateInterval string

+ ErrorBudgetSize interface{}

+ MetricPrefix string

+ ServiceName string

+ TimeFrame string

type Definition

+ func (d *Definition) AlertObjectives(monitors []*Monitor) []*Monitor

+ func (d *Definition) ExprObjectives() []string

type DefinitionConfig

+ MetricPrefix string

+ MetricSuffix string

+ func (c *DefinitionConfig) ErrorBudgetSizeParcentage() float64

+ func (c *DefinitionConfig) StartAt(now time.Time, backfill int) time.Time

type DefinitionConfigs

+ func (c DefinitionConfigs) StartAt(now time.Time, backfill int) time.Time

+ type Destination struct

+ MetricPrefix string

+ MetricSuffix string

+ ServiceName string

+ func (d *Destination) ErrorBudgetConsumptionMetricName() string

+ func (d *Destination) ErrorBudgetConsumptionPercentageMetricName() string

+ func (d *Destination) ErrorBudgetMetricName() string

+ func (d *Destination) ErrorBudgetPercentageMetricName() string

+ func (d *Destination) FailureMetricName() string

+ func (d *Destination) UpTimeMetricName() string

+ type ExprObjective struct

+ func NewExprObjective(expr evaluator.Comparator) *ExprObjective

+ func (o *ExprObjective) NewReliabilityCollection(timeFrame time.Duration, metrics Metrics, startAt, endAt time.Time) (ReliabilityCollection, error)

+ func (o *ExprObjective) String() string

+ type IsNoViolationCollection map[time.Time]bool

+ func (c IsNoViolationCollection) IsUp(t time.Time) bool

type MackerelClient

+ FindMonitors func() ([]mackerel.Monitor, error)

+ FindWithClosedAlerts func() (*mackerel.AlertsResp, error)

+ FindWithClosedAlertsByNextID func(nextID string) (*mackerel.AlertsResp, error)

+ GetMonitor func(monitorID string) (mackerel.Monitor, error)

+ type Monitor struct

+ ID string

+ Name string

+ Type string

+ func (m *Monitor) String() string

type ObjectiveConfig

+ Alert *AlertObjectiveConfig

+ func (c *ObjectiveConfig) Type() string

+ type Reliability struct

+ func NewReliability(cursorAt time.Time, timeFrame time.Duration, ...) *Reliability

+ func (r *Reliability) Clone() *Reliability

+ func (r *Reliability) CursorAt() time.Time

+ func (r *Reliability) FailureTime() time.Duration

+ func (r *Reliability) Merge(other *Reliability) (*Reliability, error)

+ func (r *Reliability) TimeFrame() time.Duration

+ func (r *Reliability) TimeFrameEndAt() time.Time

+ func (r *Reliability) TimeFrameStartAt() time.Time

+ func (r *Reliability) UpTime() time.Duration

+ type ReliabilityCollection []*Reliability

+ func NewReliabilityCollection(s []*Reliability) (ReliabilityCollection, error)

+ func (c ReliabilityCollection) CalcTime(cursor, n int) (upTime, failureTime, deltaFailureTime time.Duration)

+ func (c ReliabilityCollection) Clone() ReliabilityCollection

+ func (c ReliabilityCollection) CursorAt(i int) time.Time

+ func (c ReliabilityCollection) Len() int

+ func (c ReliabilityCollection) Less(i, j int) bool

+ func (c ReliabilityCollection) Merge(other ReliabilityCollection) (ReliabilityCollection, error)

+ func (c ReliabilityCollection) Swap(i, j int)

+ func (c ReliabilityCollection) TimeFrame() time.Duration

type Report

+ Destination *Destination

+ func NewReport(definitionID string, destination *Destination, cursorAt time.Time, ...) *Report

+ func NewReports(definitionID string, destination *Destination, errorBudgetSize float64, ...) []*Report

+ func (r *Report) SetTime(upTime time.Duration, failureTime time.Duration, ...)

type Repository

+ func (repo *Repository) FetchAlerts(ctx context.Context, startAt time.Time, endAt time.Time) (Alerts, error)

+ func (repo *Repository) FindMonitors() ([]*Monitor, error)

Nov 30, 2021

Changes in this version

type Definition

+ func (d *Definition) CreateReports(ctx context.Context, metrics Metrics) ([]*Report, error)

type Metric

+ func (m *Metric) Reaggregation(aggregateInterval time.Duration) *Metric

type MetricConfig

+ InterpolatedValue *float64

type Metrics

+ func (ms Metrics) GetVariables(startAt time.Time, endAt time.Time) map[time.Time]evaluator.Variables

Nov 14, 2021

Changes in this version

+ var ErrDashboardNotFound = errors.New("dashboard not found")

type App

+ func (app *App) DashboardBuild(ctx context.Context, optFns ...func(*Options)) error

+ func (app *App) DashboardInit(ctx context.Context, dashboardIDOrURL string) error

type Config

+ Dashboard string

+ type Dashboard = mackerel.Dashboard

type MackerelClient

+ CreateDashboard func(param *mackerel.Dashboard) (*mackerel.Dashboard, error)

+ FindDashboard func(dashboardID string) (*mackerel.Dashboard, error)

+ FindDashboards func() ([]*mackerel.Dashboard, error)

+ UpdateDashboard func(dashboardID string, param *mackerel.Dashboard) (*mackerel.Dashboard, error)

+ type Options struct

type Repository

+ func (repo *Repository) FindDashboard(dashboardIDOrURL string) (*Dashboard, error)

+ func (repo *Repository) FindDashboardID(dashboardIDOrURL string) (string, error)

+ func (repo *Repository) SaveDashboard(ctx context.Context, dashboard *Dashboard) error

Nov 11, 2021

Changes in this version

+ func MetricsComparate(c evaluator.Comparator, metrics Metrics, startAt, endAt time.Time) (map[time.Time]bool, error)

type ObjectiveConfig

+ func (c *ObjectiveConfig) GetComparator() evaluator.Comparator

Nov 1, 2021

Changes in this version

type MetricConfig

+ func (c *MetricConfig) DurationAggregation() time.Duration

Oct 30, 2021

Changes in this version

+ var ErrExprRightNotLiteral = errors.New("expr right side is value literal")

+ var ErrNotComparativeExpression = errors.New("this expr is not comparative")

+ type App struct

+ func New(apikey string, cfg *Config) (*App, error)

+ func NewWithMackerelClient(client MackerelClient, cfg *Config) (*App, error)

+ func (app *App) Run(ctx context.Context, opts ...RunOption) error

+ type Config struct

+ Definitions DefinitionConfigs

+ Metrics MetricConfigs

+ RequiredVersion string

+ func NewDefaultConfig() *Config

+ func (c *Config) Load(paths ...string) error

+ func (c *Config) Restrict() error

+ func (c *Config) ValidateVersion(version string) error

+ type Definition struct

+ func NewDefinition(cfg *DefinitionConfig) (*Definition, error)

+ func (d *Definition) CreateRepoorts(ctx context.Context, metrics Metrics) ([]*Report, error)

+ func (d *Definition) ID() string

+ type DefinitionConfig struct

+ CalculateInterval int64

+ ErrorBudgetSize float64

+ ID string

+ Objectives []*ObjectiveConfig

+ ServiceName string

+ TimeFrame int64

+ func (c *DefinitionConfig) DurationCalculate() time.Duration

+ func (c *DefinitionConfig) DurationTimeFrame() time.Duration

+ func (c *DefinitionConfig) MergeInto(o *DefinitionConfig)

+ func (c *DefinitionConfig) Restrict() error

+ type DefinitionConfigs map[string]*DefinitionConfig

+ func (c *DefinitionConfigs) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (c DefinitionConfigs) MarshalYAML() (interface{}, error)

+ func (c DefinitionConfigs) Restrict() error

+ func (c DefinitionConfigs) String() string

+ func (c DefinitionConfigs) ToSlice() []*DefinitionConfig

+ type MackerelClient interface

+ FetchHostMetricValues func(hostID string, metricName string, from int64, to int64) ([]mackerel.MetricValue, error)

+ FetchServiceMetricValues func(serviceName string, metricName string, from int64, to int64) ([]mackerel.MetricValue, error)

+ FindHosts func(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)

+ PostServiceMetricValues func(serviceName string, metricValues []*mackerel.MetricValue) error

+ type Metric struct

+ func NewMetric(cfg *MetricConfig) *Metric

+ func (m *Metric) AggregationInterval() time.Duration

+ func (m *Metric) AppendValue(t time.Time, v interface{}) error

+ func (m *Metric) EndAt() time.Time

+ func (m *Metric) GetValue(t time.Time) (float64, bool)

+ func (m *Metric) GetValues(startAt time.Time, endAt time.Time) map[time.Time]float64

+ func (m *Metric) ID() string

+ func (m *Metric) StartAt() time.Time

+ func (m *Metric) String() string

+ type MetricComparator struct

+ func NewMetricComparator(str string) (*MetricComparator, error)

+ func (mc MetricComparator) Eval(metrics Metrics, startAt, endAt time.Time) (map[time.Time]bool, error)

+ type MetricConfig struct

+ AggregationInterval int64

+ AggregationMethod string

+ HostName string

+ ID string

+ Name string

+ Roles []string

+ ServiceName string

+ Type MetricType

+ func (c *MetricConfig) MergeInto(o *MetricConfig)

+ func (c *MetricConfig) Restrict() error

+ func (c *MetricConfig) String() string

+ type MetricConfigs map[string]*MetricConfig

+ func (c *MetricConfigs) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (c MetricConfigs) MarshalYAML() (interface{}, error)

+ func (c MetricConfigs) Restrict() error

+ func (c MetricConfigs) String() string

+ func (c MetricConfigs) ToSlice() []*MetricConfig

+ type MetricType int

+ const HostMetric

+ const ServiceMetric

+ func MetricTypeString(s string) (MetricType, error)

+ func MetricTypeValues() []MetricType

+ func (i *MetricType) UnmarshalJSON(data []byte) error

+ func (i *MetricType) UnmarshalText(text []byte) error

+ func (i MetricType) IsAMetricType() bool

+ func (i MetricType) MarshalJSON() ([]byte, error)

+ func (i MetricType) MarshalText() ([]byte, error)

+ func (i MetricType) String() string

+ type Metrics map[string]*Metric

+ func (ms Metrics) AggregationInterval() time.Duration

+ func (ms Metrics) EndAt() time.Time

+ func (ms Metrics) Get(id string) (*Metric, bool)

+ func (ms Metrics) Set(m *Metric)

+ func (ms Metrics) StartAt() time.Time

+ func (ms Metrics) String() string

+ func (ms Metrics) ToSlice() []*Metric

+ type ObjectiveConfig struct

+ Expr string

+ func (c *ObjectiveConfig) GetMetricComparator() *MetricComparator

+ func (c *ObjectiveConfig) Restrict() error

+ type Report struct

+ DataPoint time.Time

+ DefinitionID string

+ ErrorBudget time.Duration

+ ErrorBudgetConsumption time.Duration

+ ErrorBudgetSize time.Duration

+ FailureTime time.Duration

+ ServiceName string

+ TimeFrameEndAt time.Time

+ TimeFrameStartAt time.Time

+ UpTime time.Duration

+ func (r *Report) ErrorBudgetConsumptionRate() float64

+ func (r *Report) ErrorBudgetUsageRate() float64

+ func (r *Report) MarshalJSON() ([]byte, error)

+ func (r *Report) String() string

+ type Repository struct

+ func NewRepository(client MackerelClient) *Repository

+ func (repo *Repository) FetchMetric(ctx context.Context, cfg *MetricConfig, startAt time.Time, endAt time.Time) (*Metric, error)

+ func (repo *Repository) FetchMetrics(ctx context.Context, cfgs MetricConfigs, startAt time.Time, endAt time.Time) (Metrics, error)

+ func (repo *Repository) SaveReports(ctx context.Context, reports []*Report) error

+ type RunOption interface

+ func BackfillOption(count int) RunOption

+ func DryRunOption(dryRun bool) RunOption