nodeevents

Documentation

Index

• Variables
• type Chore
  • func NewChore(log *zap.Logger, db DB, satellite string, notifier Notifier, config Config) *Chore
  • func (chore *Chore) Close() error
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) SetNotifier(n Notifier)
  • func (chore *Chore) SetNow(f func() time.Time)
• type Config
• type CustomerioBatch
• type CustomerioConfig
• type CustomerioData
• type CustomerioNotifier
  • func NewCustomerioNotifier(log *zap.Logger, config CustomerioConfig) *CustomerioNotifier
  • func (c *CustomerioNotifier) Notify(ctx context.Context, satellite string, events []NodeEvent) (err error)
• type DB
• type MockNotifier
  • func NewMockNotifier(log *zap.Logger) *MockNotifier
  • func (m *MockNotifier) Notify(ctx context.Context, satellite string, events []NodeEvent) (err error)
• type NodeEvent
• type Notifier
• type Type
  • func (t Type) Name() (name string, err error)

Variables

var (
	// Error is the standard error class for node events.
	Error = errs.Class("node events")
)

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore is a chore that reads events from node events and sends emails.

func NewChore

func NewChore(log *zap.Logger, db DB, satellite string, notifier Notifier, config Config) *Chore

NewChore is a constructor for Chore.

func (*Chore) Close

func (chore *Chore) Close() error

Close closes the chore.

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run runs the chore.

func (*Chore) SetNotifier

func (chore *Chore) SetNotifier(n Notifier)

SetNotifier sets the notifier on chore for testing.

func (*Chore) SetNow

func (chore *Chore) SetNow(f func() time.Time)

SetNow sets nowFn on chore for testing.

type Config

type Config struct {
	Interval            time.Duration `help:"how long to wait before checking the node events DB again if there is nothing to work on" default:"5m"`
	SelectionWaitPeriod time.Duration `` /* 130-byte string literal not displayed */
	Notifier            string        `help:"which notification provider to use" default:""`

	Customerio CustomerioConfig
}

Config contains configurable values for node events chore.

type CustomerioBatch

type CustomerioBatch struct {
	Name string         `json:"name"`
	Data CustomerioData `json:"data"`
}

CustomerioBatch contains info regarding a batch of node events for a particular node operator email address.

type CustomerioConfig

type CustomerioConfig struct {
	URL            string        `help:"the url for the customer.io endpoint to send node event data to" default:"https://track.customer.io/api/v1"`
	SiteID         string        `help:"the account id for the customer.io api" default:""`
	APIKey         string        `help:"api key for the customer.io api" default:""`
	RequestTimeout time.Duration `help:"timeout for the http request to customer.io endpoint" default:"30s"`
}

CustomerioConfig handles customer.io credentials info.

type CustomerioData

type CustomerioData struct {
	Satellite string `json:"satellite"`
	NodeIDs   string `json:"nodeIDs"`
}

CustomerioData contains the satellite name and the node IDs that had an occurrence of the event.

type CustomerioNotifier

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

CustomerioNotifier notifies customer.io about node events.

func NewCustomerioNotifier

func NewCustomerioNotifier(log *zap.Logger, config CustomerioConfig) *CustomerioNotifier

NewCustomerioNotifier is a constructor for CustomerioNotifier.

func (*CustomerioNotifier) Notify

func (c *CustomerioNotifier) Notify(ctx context.Context, satellite string, events []NodeEvent) (err error)

Notify sends node event data to customer.io.

type DB

type DB interface {
	// Insert a node event into the node events table.
	Insert(ctx context.Context, email string, nodeID storj.NodeID, event Type) (nodeEvent NodeEvent, err error)
	// GetLatestByEmailAndEvent gets latest node event by email and event type.
	GetLatestByEmailAndEvent(ctx context.Context, email string, event Type) (nodeEvent NodeEvent, err error)
	// GetNextBatch gets the next batch of events to combine into an email.
	GetNextBatch(ctx context.Context, firstSeenBefore time.Time) (events []NodeEvent, err error)
	// GetByID get a node event by id.
	GetByID(ctx context.Context, id uuid.UUID) (nodeEvent NodeEvent, err error)
	// UpdateEmailSent updates email_sent for a group of rows.
	UpdateEmailSent(ctx context.Context, ids []uuid.UUID, timestamp time.Time) (err error)
	// UpdateLastAttempted updates last_attempted for a group of rows.
	UpdateLastAttempted(ctx context.Context, ids []uuid.UUID, timestamp time.Time) (err error)
}

DB implements the database for node events.

architecture: Database

type MockNotifier

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

MockNotifier implements the Notifier interface.

func NewMockNotifier

func NewMockNotifier(log *zap.Logger) *MockNotifier

NewMockNotifier is a constructor for MockNotifier.

func (*MockNotifier) Notify

func (m *MockNotifier) Notify(ctx context.Context, satellite string, events []NodeEvent) (err error)

Notify stores the events in the Notifications field so they can be checked.

type NodeEvent

type NodeEvent struct {
	ID            uuid.UUID
	Email         string
	NodeID        storj.NodeID
	Event         Type
	CreatedAt     time.Time
	LastAttempted *time.Time
	EmailSent     *time.Time
}

NodeEvent contains information needed to notify a node operator about something that happened to a node.

type Notifier

type Notifier interface {
	// Notify notifies a node operator about an event that occurred on some of their nodes.
	Notify(ctx context.Context, satellite string, events []NodeEvent) (err error)
}

Notifier notifies node operators about node events.

type Type

type Type int

Type is a type of node event.

const (
	// Online indicates that the node has come back online.
	Online Type = 0
	// Offline indicates that the node is offline.
	Offline Type = 1
	// Disqualified indicates that the node is disqualified.
	Disqualified Type = 2
	// UnknownAuditSuspended indicates that the node is suspended for unknown audit errors.
	UnknownAuditSuspended Type = 3
	// UnknownAuditUnsuspended indicates that the node is no longer suspended for unknown audit errors.
	UnknownAuditUnsuspended Type = 4
	// OfflineSuspended indicates that the node is suspended for being offline.
	OfflineSuspended Type = 5
	// OfflineUnsuspended indicates that the node is no longer suspended for being offline.
	OfflineUnsuspended Type = 6
	// BelowMinVersion indicates that the node's software is below the minimum version.
	BelowMinVersion Type = 7
)

func (Type) Name

func (t Type) Name() (name string, err error)

Name returns the name of the node event Type.