prepalert

Oct 1, 2023

Changes in this version

type App

+ func (app *App) RetryPolicy() *RetryPolicy

+ type RetryPolicy struct

+ BackoffFactor float64

+ Interval float64

+ Jitter float64

+ MaxInterval float64

+ func (rp *RetryPolicy) DecodeAttributes(attrs hcl.Attributes, evalCtx *hcl.EvalContext) hcl.Diagnostics

+ func (rp *RetryPolicy) SetRetryAfter(w http.ResponseWriter, r *http.Request)

+ func (rp *RetryPolicy) String() string

Sep 24, 2023

Changes in this version

+ const FindGraphAnnotationOffset

+ const HeaderRequestID

+ var AlertMemoMaxSize = 80 * 1000

+ var CacheDuration = 1 * time.Minute

+ var GraphAnnotationDescriptionMaxSize = 1024

+ func ExpressionToString(expr hcl.Expression, evalCtx *hcl.EvalContext) (string, error)

+ func GenerateInitialConfig(sqsQueueName string, orgName string) ([]byte, error)

type App

+ func (app *App) Backend() Backend

+ func (app *App) Close() error

+ func (app *App) DecodeBody(body hcl.Body, evalCtx *hcl.EvalContext) hcl.Diagnostics

+ func (app *App) EnableWebhookServer() bool

+ func (app *App) ExecuteRules(ctx context.Context, body *WebhookBody) error

+ func (app *App) Init(ctx context.Context, outputPath string) error

+ func (app *App) LoadConfig(dir string, optFns ...func(*LoadConfigOptions)) error

+ func (app *App) LoadPlugin(ctx context.Context, cfg *LoadPluginConfig) error

+ func (app *App) MackerelService() *MackerelService

+ func (app *App) NewEvalContext(body *WebhookBody) (*hcl.EvalContext, error)

+ func (app *App) NewRule(ruleName string) *Rule

+ func (app *App) ProviderList() []string

+ func (app *App) QueryList() []string

+ func (app *App) Rules() []*Rule

+ func (app *App) SQSQueueName() string

+ func (app *App) SetMackerelClient(client MackerelClient) *App

+ func (app *App) SetupS3Buckend(body hcl.Body) hcl.Diagnostics

+ func (app *App) UnwrapAndDumpDiagnoctics(err error) error

+ func (app *App) WebhookServerIsReady() bool

+ func (app *App) WithPrepalertFunctions(evalCtx *hcl.EvalContext) *hcl.EvalContext

+ func (app *App) WorkerIsReady() bool

+ type Backend interface

+ Upload func(ctx context.Context, evalCtx *hcl.EvalContext, name string, body io.Reader) (string, bool, error)

type CLI

+ ErrorHandling ErrorHandling

+ type DiscardBackend struct

+ func NewDiscardBackend() *DiscardBackend

+ func (b *DiscardBackend) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (b *DiscardBackend) String() string

+ func (b *DiscardBackend) Upload(ctx context.Context, evalCtx *hcl.EvalContext, name string, body io.Reader) (string, bool, error)

+ type ErrorHandling int

+ const ContinueOnError

+ const ReturnOnError

+ func (e *ErrorHandling) UnmarshalText(text []byte) error

+ func (e ErrorHandling) String() string

+ type LoadConfigOptions struct

+ Color *bool

+ DiagnosticDestination io.Writer

+ Width *uint

+ type LoadPluginConfig struct

+ Command string

+ PluginName string

+ SyncOutput bool

+ type MackerelClient interface

+ CreateGraphAnnotation func(annotation *mackerel.GraphAnnotation) (*mackerel.GraphAnnotation, error)

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

+ FindHost func(id string) (*mackerel.Host, error)

+ GetAlert func(string) (*mackerel.Alert, error)

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

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

+ UpdateAlert func(alertID string, param mackerel.UpdateAlertParam) (*mackerel.UpdateAlertResponse, error)

+ UpdateGraphAnnotation func(annotationID string, annotation *mackerel.GraphAnnotation) (*mackerel.GraphAnnotation, error)

+ type MackerelService struct

+ func NewMackerelService(client MackerelClient) *MackerelService

+ func (svc *MackerelService) GetAlertWithCache(ctx context.Context, alertID string) (*mackerel.Alert, error)

+ func (svc *MackerelService) GetMonitorByAlertID(ctx context.Context, alertID string) (mackerel.Monitor, error)

+ func (svc *MackerelService) GetMonitorWithCache(ctx context.Context, monitorID string) (mackerel.Monitor, error)

+ func (svc *MackerelService) NewEmulatedWebhookBody(ctx context.Context, alertID string) (*WebhookBody, error)

+ func (svc *MackerelService) NewExampleWebhookBody() *WebhookBody

+ func (svc *MackerelService) NewMackerelUpdater(body *WebhookBody, backend Backend) *MackerelUpdater

+ func (svc *MackerelService) PostGraphAnnotation(ctx context.Context, params *mackerel.GraphAnnotation) error

+ func (svc *MackerelService) UpdateAlertMemo(ctx context.Context, alertID string, memo string) error

+ type MackerelUpdater struct

+ func (u *MackerelUpdater) AddAdditionalDescription(service string, text string)

+ func (u *MackerelUpdater) AddMemoSectionText(text string, sizeLimit *int)

+ func (u *MackerelUpdater) AddService(service string)

+ func (u *MackerelUpdater) Flush(ctx context.Context, evalCtx *hcl.EvalContext) error

+ type PostGraphAnnotationAction struct

+ func (action *PostGraphAnnotationAction) DecodeBody(body hcl.Body, evalCtx *hcl.EvalContext) hcl.Diagnostics

+ func (action *PostGraphAnnotationAction) DependsOnQueries() []string

+ func (action *PostGraphAnnotationAction) Enable() bool

+ func (action *PostGraphAnnotationAction) Execute(ctx context.Context, evalCtx *hcl.EvalContext, u *MackerelUpdater) error

+ type RequestIDGenerator interface

+ NextID func() (uint64, error)

+ var DefaultRequestIDGeneartor RequestIDGenerator = must(katsubushi.NewGenerator(1))

type Rule

+ func (rule *Rule) DecodeBody(body hcl.Body, evalCtx *hcl.EvalContext) hcl.Diagnostics

+ func (rule *Rule) DependsOnQueries() []string

+ func (rule *Rule) Execute(ctx context.Context, evalCtx *hcl.EvalContext, u *MackerelUpdater) error

+ func (rule *Rule) PostGraphAnnotationAction() *PostGraphAnnotationAction

+ func (rule *Rule) Priority() int

+ func (rule *Rule) UpdateAlertAction() *UpdateAlertAction

+ type S3Backend struct

+ Allowed []string

+ BucketName string

+ Denied []string

+ ObjectKeyPrefix *string

+ ObjectKeyTemplate *hcl.Expression

+ ViewerBaseURL *url.URL

+ ViewerBaseURLString string

+ ViewerGoogleClientID *string

+ ViewerGoogleClientSecret *string

+ ViewerSessionEncryptKey []byte

+ ViewerSessionEncryptKeyString *string

+ func (b *S3Backend) EnableGoogleAuth() bool

+ func (b *S3Backend) IsEmpty() bool

+ func (b *S3Backend) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (b *S3Backend) String() string

+ func (b *S3Backend) Upload(ctx context.Context, evalCtx *hcl.EvalContext, name string, body io.Reader) (string, bool, error)

+ type S3Client interface

+ var GlobalS3Client S3Client

+ type UpdateAlertAction struct

+ func (action *UpdateAlertAction) DecodeBody(body hcl.Body, evalCtx *hcl.EvalContext) hcl.Diagnostics

+ func (action *UpdateAlertAction) DependsOnQueries() []string

+ func (action *UpdateAlertAction) Enable() bool

+ func (action *UpdateAlertAction) Execute(ctx context.Context, evalCtx *hcl.EvalContext, u *MackerelUpdater) error

type WebhookBody

+ Text string

+ func WebhookFromEvalContext(evalCtx *hcl.EvalContext) (*WebhookBody, error)

Dec 22, 2022

Changes in this version

+ var Version = "current"

+ func RunCLI(ctx context.Context, args []string, setLogLevel func(string)) error

+ type CLI struct

+ Config string

+ Exec *ExecOptions

+ Init struct{}

+ LogLevel string

+ MackerelAPIKey string

+ Run *RunOptions

+ Validate struct{}

+ Version struct{}

+ func ParseCLI(ctx context.Context, args []string, opts ...kong.Option) (string, *CLI, error)

+ type ExecOptions struct

+ AlertID string

Dec 2, 2022

Changes in this version

type Rule

+ func (rule *Rule) BuildInformation(ctx context.Context, evalCtx *hcl.EvalContext, body *WebhookBody) (string, error)

+ func (rule *Rule) RenderInformation(evalCtx *hcl.EvalContext) (string, error)

Dec 1, 2022

Changes in this version

type App

+ func (app *App) PostGraphAnnotation(ctx context.Context, body *WebhookBody, params *mackerel.GraphAnnotation) error

+ func (app *App) UpdateAlertMemo(ctx context.Context, body *WebhookBody, memo string) error

type Rule

+ func (rule *Rule) MaxAlertMemoSize() int

+ func (rule *Rule) MaxGraphAnnotationDescriptionSize() int

+ func (rule *Rule) PostGraphAnnotation() bool

+ func (rule *Rule) UpdateAlertMemo() bool

Oct 14, 2022

Changes in this version

type Alert

+ func (body *Alert) MarshalCTYValues() map[string]cty.Value

type Host

+ func (body *Host) MarshalCTYValues() map[string]cty.Value

type Role

+ func (body *Role) MarshalCTYValues() map[string]cty.Value

type Service

+ func (body *Service) MarshalCTYValues() map[string]cty.Value

type WebhookBody

+ func (body *WebhookBody) MarshalCTYValues() map[string]cty.Value

Sep 15, 2022

Changes in this version

type App

+ func (app *App) Exec(ctx context.Context, alertID string) error

+ func (app *App) NewWebhookBody(ctx context.Context, alertID string) (*WebhookBody, error)

+ func (app *App) ProcessRules(ctx context.Context, body *WebhookBody) error

type Rule

+ func (rule *Rule) Name() string

Sep 10, 2022

Changes in this version

type App

+ func (app *App) EnableBackend() bool

Sep 7, 2022

Changes in this version

type App

+ func (app *App) WithQueryRunningContext(ctx context.Context, reqID uint64, message *events.SQSMessage) context.Context

type QueryData

+ Params interface{}

+ type RenderInfomationData struct

+ Params interface{}

+ QueryResults map[string]*queryrunner.QueryResult

type Rule

+ func (rule *Rule) BuildInfomation(ctx context.Context, body *WebhookBody) (string, error)

+ func (rule *Rule) RenderInfomation(ctx context.Context, data *RenderInfomationData) (string, error)

Sep 1, 2022

Changes in this version

+ type QueryData struct

+ Variables map[string]interface{}

type RenderMemoData

+ Variables map[string]interface{}

type RuleConfig

+ Variables map[string]interface{}

Sep 1, 2022

Changes in this version

type HandleContext

+ func (hctx *HandleContext) ChangeSQSMessageVisibilityTimeout(ctx context.Context, visibilityTimeout time.Duration) error

Aug 31, 2022

Changes in this version

+ var AWSConfigCache *aws.Config

+ func QueryRunnerTypeSliceContains(enums []QueryRunnerType, sunEnums ...QueryRunnerType) bool

+ func QueryRunnerTypeSliceContainsAny(enums []QueryRunnerType, sunEnums ...QueryRunnerType) bool

+ func Strftime(layout string, loc *time.Location, t time.Time) string

+ func StrftimeInZone(layout string, zone string, t time.Time) string

+ func WithHandleContext(ctx context.Context, info *HandleContext) context.Context

+ type Alert struct

+ ClosedAt int64

+ CreatedAt int64

+ CriticalThreshold float64

+ Duration int64

+ ID string

+ IsOpen bool

+ MetricLabel string

+ MetricValue float64

+ MonitorName string

+ MonitorOperator string

+ OpenedAt int64

+ Status string

+ Trigger string

+ URL string

+ WarningThreshold float64

+ type App struct

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

+ func (app *App) CheckBasicAuth(r *http.Request) bool

+ func (app *App) EnableBasicAuth() bool

+ func (app *App) HandleSQS(ctx context.Context, event *events.SQSEvent) (*grat.BatchItemFailureResponse, error)

+ func (app *App) NewHandleContext(reqID uint64, message *events.SQSMessage) *HandleContext

+ func (app *App) ProcessRule(ctx context.Context, rule *Rule, body *WebhookBody) error

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

+ func (app *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type AuthConfig struct

+ ClientID string

+ ClientSecret string

+ func (cfg *AuthConfig) Restrict() error

+ type CompiledQuery interface

+ Name func() string

+ Run func(context.Context, *WebhookBody) (*QueryResult, error)

+ type Config struct

+ Auth *AuthConfig

+ QueryRunners QueryRunnerConfigs

+ RequiredVersion string

+ Rules []*RuleConfig

+ SQSQueueName string

+ Service string

+ func DefaultConfig() *Config

+ func (cfg *Config) Load(path string) error

+ func (cfg *Config) Restrict() error

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

+ type HandleContext struct

+ ReqID uint64

+ func GetHandleContext(ctx context.Context) (*HandleContext, bool)

+ func (hctx *HandleContext) ExtendTimeout(ctx context.Context, d time.Duration) error

+ type Host struct

+ ID string

+ IsRetired bool

+ Memo string

+ Name string

+ Roles []*Role

+ Status string

+ Type string

+ URL string

+ type MemoConfig struct

+ File string

+ Text string

+ func (cfg *MemoConfig) Restrict(baseDir string) error

+ type MonitorConfig struct

+ ID string

+ Name string

+ func (cfg *MonitorConfig) Restrict() error

+ type QueryConfig struct

+ File string

+ Name string

+ Query string

+ Runner string

+ func (cfg *QueryConfig) Restrict(baseDir string, queryRunners QueryRunnerConfigs) error

+ type QueryResult struct

+ Columns []string

+ Name string

+ Query string

+ Rows [][]string

+ func NewEmptyQueryResult(name string, query string) *QueryResult

+ func NewQueryResult(name string, query string, columns []string, rows [][]string) *QueryResult

+ func (qr *QueryResult) ToTable() string

+ func (qr *QueryResult) ToVertical() string

+ type QueryRunner interface

+ Compile func(*QueryConfig) (CompiledQuery, error)

+ func NewQueryRunner(cfg *QueryRunnerConfig) (QueryRunner, error)

+ type QueryRunnerConfig struct

+ ClusterIdentifier string

+ DBUser string

+ Database string

+ Name string

+ SecretsARN string

+ Type QueryRunnerType

+ WorkgroupName string

+ func (cfg *QueryRunnerConfig) Restrict() error

+ type QueryRunnerConfigs []*QueryRunnerConfig

+ func (cfgs QueryRunnerConfigs) Get(name string) (*QueryRunnerConfig, bool)

+ func (cfgs QueryRunnerConfigs) Len() int

+ func (cfgs QueryRunnerConfigs) Restrict() error

+ type QueryRunnerType int

+ const QueryRunnerTypeRedshiftData

+ func ParseQueryRunnerTypeString(s string) (QueryRunnerType, error)

+ func QueryRunnerTypeValues() []QueryRunnerType

+ func (i *QueryRunnerType) Scan(value interface{}) error

+ func (i *QueryRunnerType) UnmarshalBinary(data []byte) error

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

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

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

+ func (i QueryRunnerType) MarshalBinary() (data []byte, err error)

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

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

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

+ func (i QueryRunnerType) New() *QueryRunnerType

+ func (i QueryRunnerType) Registered() bool

+ func (i QueryRunnerType) String() string

+ func (i QueryRunnerType) Value() (driver.Value, error)

+ type QueryRunners map[string]QueryRunner

+ func NewQueryRunners(cfgs QueryRunnerConfigs) (QueryRunners, error)

+ func (runners QueryRunners) Get(name string) (QueryRunner, bool)

+ type RedshiftDataCompiledQuery struct

+ func (q *RedshiftDataCompiledQuery) Name() string

+ func (q *RedshiftDataCompiledQuery) Run(ctx context.Context, body *WebhookBody) (*QueryResult, error)

+ type RedshiftDataQueryRunner struct

+ func (r *RedshiftDataQueryRunner) Compile(cfg *QueryConfig) (CompiledQuery, error)

+ func (r *RedshiftDataQueryRunner) RunQuery(ctx context.Context, stmtName string, query string) (*QueryResult, error)

+ type RenderMemoData struct

+ QueryResults map[string]*QueryResult

+ type Role struct

+ Fullname string

+ RoleName string

+ RoleURL string

+ ServiceName string

+ ServiceURL string

+ type Rule struct

+ func NewRule(client *mackerel.Client, cfg *RuleConfig, runners QueryRunners) (*Rule, error)

+ func (rule *Rule) BuildMemo(ctx context.Context, body *WebhookBody) (string, error)

+ func (rule *Rule) Match(body *WebhookBody) bool

+ func (rule *Rule) RenderMemo(ctx context.Context, data *RenderMemoData) (string, error)

+ type RuleConfig struct

+ Memo *MemoConfig

+ Monitor *MonitorConfig

+ Queries []*QueryConfig

+ func (cfg *RuleConfig) Restrict(baseDir string, queryRunners QueryRunnerConfigs) error

+ type RunOptions struct

+ Address string

+ BatchSize int

+ Mode string

+ Prefix string

+ type Service struct

+ ID string

+ Memo string

+ Name string

+ OrgID string

+ Roles []*Role

+ type Waiter struct

+ Jitter time.Duration

+ MaxDelay time.Duration

+ MinDelay time.Duration

+ StartTime time.Time

+ Timeout time.Duration

+ func (w *Waiter) Continue(ctx context.Context) bool

+ type WebhookBody struct

+ Alert *Alert

+ Event string

+ Host *Host

+ ImageURL string

+ Memo string

+ OrgName string

+ Service *Service