events

package

v0.0.0-...-eb3ab3a Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alcionai/corso

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func Inc(cat metricsCategory, keys ...string)
func IncN(n int, cat metricsCategory, keys ...string)
func NewMetrics(ctx context.Context, w io.Writer) (context.Context, func())
func Since(start time.Time, cat metricsCategory, keys ...string)
type Bus
- func NewBus(ctx context.Context, s storage.Storage, tenID string, co control.Options) (Bus, error)
type Eventer

Constants ¶

View Source

const (

	// Event Keys
	RepoInit       = "Repo Init"
	RepoConnect    = "Repo Connect"
	BackupEnd      = "Backup End"
	RestoreEnd     = "Restore End"
	ExportEnd      = "Export End"
	MaintenanceEnd = "Maintenance End"

	// Event Data Keys
	BackupCreateTime = "backup_creation_time"
	BackupID         = "backup_id"
	DataRetrieved    = "data_retrieved"
	DataStored       = "data_stored"
	Duration         = "duration"
	EndTime          = "end_time"
	ItemsRead        = "items_read"
	ItemsWritten     = "items_written"
	Resources        = "resources"
	RestoreID        = "restore_id"
	ExportID         = "export_id"
	Service          = "service"
	StartTime        = "start_time"
	Status           = "status"

	// default values for keys
	RepoIDNotFound = "not_found"
)

keys for ease of use

View Source

const (
	APICall metricsCategory = "api_call"
)

metrics collection bucket

Variables ¶

View Source

var (
	RudderStackWriteKey     string
	RudderStackDataPlaneURL string
)

Functions ¶

func Inc ¶

func Inc(cat metricsCategory, keys ...string)

Inc increments the given category by 1.

func IncN ¶

func IncN(n int, cat metricsCategory, keys ...string)

IncN increments the given category by N.

func NewMetrics ¶

func NewMetrics(ctx context.Context, w io.Writer) (context.Context, func())

NewMetrics embeds a metrics bus into the provided context. The bus can be utilized with calls like Inc and Since.

func Since ¶

func Since(start time.Time, cat metricsCategory, keys ...string)

Since records the duration between the provided time and now, in millis.

Types ¶

type Bus ¶

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

Bus handles all event communication into the events package.

func NewBus ¶

func NewBus(ctx context.Context, s storage.Storage, tenID string, co control.Options) (Bus, error)

func (Bus) Close ¶

func (b Bus) Close() error

func (Bus) Event ¶

func (b Bus) Event(ctx context.Context, key string, data map[string]any)

func (*Bus) SetRepoID ¶

func (b *Bus) SetRepoID(hash string)

type Eventer ¶

type Eventer interface {
	Event(context.Context, string, map[string]any)
	Close() error
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL