Documentation
¶
Index ¶
Constants ¶
View Source
const ( // Welcome is displayed the first time the telemetry config is created. Welcome = `` /* 145-byte string literal not displayed */ )
Variables ¶
View Source
var ConfigFile = filepath.Join(".airbyte", "analytics.yml")
Functions ¶
func WriteConfigToFile ¶
WriteConfigToFile will write the cfg to the provided path.
Types ¶
type Client ¶
type Client interface {
// Start should be called as soon quickly as possible.
Start(EventType) error
// Success should be called only if the activity succeeded.
Success(EventType) error
// Failure should be called only if the activity failed.
Failure(EventType, error) error
// Attr should be called to add additional attributes to this activity.
Attr(key, val string)
}
Client interface for telemetry data.
type Config ¶
type Config struct {
UserID ULID `yaml:"anonymous_user_id"`
}
Config represents the analytics.yaml file.
func LoadConfigFromFile ¶
type EventState ¶
type EventState string
const ( Start EventState = "started" Failed EventState = "failed" Success EventState = "succeeded" )
type NoopClient ¶
type NoopClient struct {
}
NoopClient client, all methods are no-ops.
func (NoopClient) Attr ¶
func (n NoopClient) Attr(key, val string)
func (NoopClient) Start ¶
func (n NoopClient) Start(EventType) error
func (NoopClient) Success ¶
func (n NoopClient) Success(EventType) error
type SegmentClient ¶
type SegmentClient struct {
// contains filtered or unexported fields
}
SegmentClient client, all methods communicate with segment.
func NewSegmentClient ¶
func NewSegmentClient(cfg Config) *SegmentClient
func (*SegmentClient) Attr ¶
func (s *SegmentClient) Attr(key, val string)
func (*SegmentClient) Start ¶
func (s *SegmentClient) Start(et EventType) error
func (*SegmentClient) Success ¶
func (s *SegmentClient) Success(et EventType) error
Source Files
Click to show internal directories.
Click to hide internal directories.