reporter

Documentation

Index

• Constants
• type Datadog
  • func NewDatadog(config DatadogConfig, logger boshlog.Logger) Datadog
  • func (r Datadog) ReportEventExecutionCompletion(incidentID string, e Event)
  • func (r Datadog) ReportEventExecutionStart(incidentID string, e Event)
  • func (r Datadog) ReportIncidentExecutionCompletion(i Incident)
  • func (r Datadog) ReportIncidentExecutionStart(i Incident)
• type DatadogConfig
  • func (c DatadogConfig) Required() bool
  • func (c DatadogConfig) Validate() error
• type DirectorEvents
  • func NewDirectorEvents(director director.Director, logger boshlog.Logger) DirectorEvents
  • func (r DirectorEvents) ReportEventExecutionCompletion(incidentID string, e Event)
  • func (r DirectorEvents) ReportEventExecutionStart(incidentID string, e Event)
  • func (r DirectorEvents) ReportIncidentExecutionCompletion(i Incident)
  • func (r DirectorEvents) ReportIncidentExecutionStart(i Incident)
• type Event
  • func (e *Event) ErrorStr() string
  • func (e *Event) IsAction() bool
  • func (e *Event) MarkError(err error) bool
• type EventInstance
• type EventInstanceResp
• type EventResponse
  • func NewEventResponse(event *Event) EventResponse
  • func (r EventResponse) DescriptionHTML() template.HTML
  • func (r EventResponse) IsAction() bool
• type EventResult
• type Events
  • func NewEvents(uuidGen boshuuid.Generator, reporter Reporter, incidentID string, ...) *Events
  • func (e *Events) Add(event Event) *Event
  • func (e *Events) Events() []*Event
  • func (e *Events) FirstError() error
  • func (e *Events) RegisterResult(r EventResult)
  • func (e *Events) Results() chan EventResult
• type Incident
• type Logger
  • func NewLogger(logger boshlog.Logger) Logger
  • func (r Logger) ReportEventExecutionCompletion(incidentID string, e Event)
  • func (r Logger) ReportEventExecutionStart(incidentID string, e Event)
  • func (r Logger) ReportIncidentExecutionCompletion(i Incident)
  • func (r Logger) ReportIncidentExecutionStart(i Incident)
• type Multi
  • func NewMulti(reps []Reporter) Multi
  • func (r Multi) ReportEventExecutionCompletion(incidentID string, e Event)
  • func (r Multi) ReportEventExecutionStart(incidentID string, e Event)
  • func (r Multi) ReportIncidentExecutionCompletion(i Incident)
  • func (r Multi) ReportIncidentExecutionStart(i Incident)
• type Reporter

Constants

const (
	EventTypeFind   = "Find"
	EventTypeSelect = "Select"
)

Types

type Datadog

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

func NewDatadog

func NewDatadog(config DatadogConfig, logger boshlog.Logger) Datadog

func (Datadog) ReportEventExecutionCompletion

func (r Datadog) ReportEventExecutionCompletion(incidentID string, e Event)

func (Datadog) ReportEventExecutionStart

func (r Datadog) ReportEventExecutionStart(incidentID string, e Event)

func (Datadog) ReportIncidentExecutionCompletion

func (r Datadog) ReportIncidentExecutionCompletion(i Incident)

func (Datadog) ReportIncidentExecutionStart

func (r Datadog) ReportIncidentExecutionStart(i Incident)

type DatadogConfig

type DatadogConfig struct {
	APIKey string
	AppKey string
}

func (DatadogConfig) Required

func (c DatadogConfig) Required() bool

func (DatadogConfig) Validate

func (c DatadogConfig) Validate() error

type DirectorEvents

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

func NewDirectorEvents

func NewDirectorEvents(director director.Director, logger boshlog.Logger) DirectorEvents

func (DirectorEvents) ReportEventExecutionCompletion

func (r DirectorEvents) ReportEventExecutionCompletion(incidentID string, e Event)

func (DirectorEvents) ReportEventExecutionStart

func (r DirectorEvents) ReportEventExecutionStart(incidentID string, e Event)

func (DirectorEvents) ReportIncidentExecutionCompletion

func (r DirectorEvents) ReportIncidentExecutionCompletion(i Incident)

func (DirectorEvents) ReportIncidentExecutionStart

func (r DirectorEvents) ReportIncidentExecutionStart(i Incident)

type Event

type Event struct {
	ID   string // may be empty
	Type string

	Instance EventInstance // may be empty

	ExecutionStartedAt   time.Time
	ExecutionCompletedAt time.Time

	Error error
	// contains filtered or unexported fields
}

func (*Event) ErrorStr

func (e *Event) ErrorStr() string

func (*Event) IsAction

func (e *Event) IsAction() bool

func (*Event) MarkError

func (e *Event) MarkError(err error) bool

type EventInstance

type EventInstance struct {
	ID         string
	Group      string
	Deployment string
	AZ         string
}

type EventInstanceResp

type EventInstanceResp struct {
	ID         string
	Group      string
	Deployment string
	AZ         string
}

type EventResponse

type EventResponse struct {
	ID   string
	Type string

	Instance EventInstanceResp

	ExecutionStartedAt   string
	ExecutionCompletedAt string

	Error string
	// contains filtered or unexported fields
}

func NewEventResponse

func NewEventResponse(event *Event) EventResponse

func (EventResponse) DescriptionHTML

func (r EventResponse) DescriptionHTML() template.HTML

func (EventResponse) IsAction

func (r EventResponse) IsAction() bool

type EventResult

type EventResult struct {
	Event *Event
	Error error
}

type Events

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

func NewEvents

func NewEvents(uuidGen boshuuid.Generator, reporter Reporter, incidentID string, logger boshlog.Logger) *Events

func (*Events) Add

func (e *Events) Add(event Event) *Event

func (*Events) Events

func (e *Events) Events() []*Event

func (*Events) FirstError

func (e *Events) FirstError() error

func (*Events) RegisterResult

func (e *Events) RegisterResult(r EventResult)

func (*Events) Results

func (e *Events) Results() chan EventResult

type Incident

type Incident interface {
	ID() string

	TaskTypes() []string
	ShortDescription() (string, error)

	Events() *Events

	ExecutionStartedAt() time.Time
	ExecutionCompletedAt() time.Time
}

type Logger

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

func NewLogger

func NewLogger(logger boshlog.Logger) Logger

func (Logger) ReportEventExecutionCompletion

func (r Logger) ReportEventExecutionCompletion(incidentID string, e Event)

func (Logger) ReportEventExecutionStart

func (r Logger) ReportEventExecutionStart(incidentID string, e Event)

func (Logger) ReportIncidentExecutionCompletion

func (r Logger) ReportIncidentExecutionCompletion(i Incident)

func (Logger) ReportIncidentExecutionStart

func (r Logger) ReportIncidentExecutionStart(i Incident)

type Multi

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

func NewMulti

func NewMulti(reps []Reporter) Multi

func (Multi) ReportEventExecutionCompletion

func (r Multi) ReportEventExecutionCompletion(incidentID string, e Event)

func (Multi) ReportEventExecutionStart

func (r Multi) ReportEventExecutionStart(incidentID string, e Event)

func (Multi) ReportIncidentExecutionCompletion

func (r Multi) ReportIncidentExecutionCompletion(i Incident)

func (Multi) ReportIncidentExecutionStart

func (r Multi) ReportIncidentExecutionStart(i Incident)

type Reporter

type Reporter interface {
	ReportIncidentExecutionStart(Incident)
	ReportIncidentExecutionCompletion(Incident)

	ReportEventExecutionStart(string, Event)
	ReportEventExecutionCompletion(string, Event)
}