command

Documentation

Overview

Package command implements a Pilot notification plugin that executes a user-provided script from /config/scripts/ on each event. The event payload is passed as JSON on stdin and key fields are set as environment variables.

Index

• Variables
• type Config
• type Notifier
  • func New(cfg Config) *Notifier
  • func (*Notifier) Name() string
  • func (n *Notifier) Notify(ctx context.Context, event plugin.NotificationEvent) error
  • func (n *Notifier) Test(_ context.Context) error

Variables

var ScriptsDir = "/config/scripts" //nolint:gochecknoglobals // injectable for tests

ScriptsDir is the directory from which scripts are resolved. Package-level var so tests can override it.

Types

type Config

type Config struct {
	ScriptName string `json:"script_name"`
	Timeout    int    `json:"timeout,omitempty"` // seconds; default 30
}

Config holds the user-supplied settings for a command notifier.

type Notifier

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

Notifier is a command notifier plugin instance.

func New

func New(cfg Config) *Notifier

New creates a new Notifier from the given config.

func (*Notifier) Name

func (*Notifier) Name() string

func (*Notifier) Notify

func (n *Notifier) Notify(ctx context.Context, event plugin.NotificationEvent) error

Notify executes the configured script with event data.

func (*Notifier) Test

func (n *Notifier) Test(_ context.Context) error

Test verifies the script file exists and is executable.