telemetry

package
v1.36.1--pre-release Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type NoopTelemetry

type NoopTelemetry struct {
}

NoopTelemetry satisfies the Telemetry interface with no-op implementations.

func (*NoopTelemetry) AddChecklist

func (t *NoopTelemetry) AddChecklist(playbookRunID, userID string, checklist app.Checklist)

AddChecklist does nothing

func (*NoopTelemetry) AddPostToTimeline

func (t *NoopTelemetry) AddPostToTimeline(*app.PlaybookRun, string)

AddPostToTimeline does nothing

func (*NoopTelemetry) AddTask

AddTask does nothing.

func (*NoopTelemetry) AutoFollowPlaybook

func (t *NoopTelemetry) AutoFollowPlaybook(playbook app.Playbook, userID string)

AutoFollowPlaybook tracks the auto-follow of a playbook.

func (*NoopTelemetry) AutoUnfollowPlaybook

func (t *NoopTelemetry) AutoUnfollowPlaybook(playbook app.Playbook, userID string)

AutoUnfollowPlaybook tracks the auto-unfollow of a playbook.

func (*NoopTelemetry) ChangeDigestSettings

func (t *NoopTelemetry) ChangeDigestSettings(userID string, old app.DigestNotificationSettings, new app.DigestNotificationSettings)

ChangeDigestSettings does nothing

func (*NoopTelemetry) ChangeOwner

func (t *NoopTelemetry) ChangeOwner(*app.PlaybookRun, string)

ChangeOwner does nothing

func (*NoopTelemetry) CreatePlaybook

func (t *NoopTelemetry) CreatePlaybook(app.Playbook, string)

CreatePlaybook does nothing.

func (*NoopTelemetry) CreatePlaybookRun

func (t *NoopTelemetry) CreatePlaybookRun(*app.PlaybookRun, string, bool)

CreatePlaybookRun does nothing

func (*NoopTelemetry) DeletePlaybook

func (t *NoopTelemetry) DeletePlaybook(app.Playbook, string)

DeletePlaybook does nothing.

func (*NoopTelemetry) Disable

func (t *NoopTelemetry) Disable() error

Disable does nothing, returning always nil.

func (*NoopTelemetry) Enable

func (t *NoopTelemetry) Enable() error

Enable does nothing, returning always nil.

func (*NoopTelemetry) FavoriteItem added in v1.31.0

func (t *NoopTelemetry) FavoriteItem(item app.CategoryItem, userID string)

FavoriteItem does nothing

func (*NoopTelemetry) FinishPlaybookRun

func (t *NoopTelemetry) FinishPlaybookRun(*app.PlaybookRun, string)

EndPlaybookRun does nothing

func (*NoopTelemetry) Follow

func (t *NoopTelemetry) Follow(playbookRun *app.PlaybookRun, userID string)

Follow tracks userID following a playbook run.

func (*NoopTelemetry) FrontendTelemetryForPlaybook

func (t *NoopTelemetry) FrontendTelemetryForPlaybook(playbook app.Playbook, userID, action string)

FrontendTelemetryForPlaybook does nothing.

func (*NoopTelemetry) FrontendTelemetryForPlaybookRun

func (t *NoopTelemetry) FrontendTelemetryForPlaybookRun(*app.PlaybookRun, string, string)

FrontendTelemetryForPlaybookRun does nothing

func (*NoopTelemetry) FrontendTelemetryForPlaybookTemplate

func (t *NoopTelemetry) FrontendTelemetryForPlaybookTemplate(templateName string, userID, action string)

FrontendTelemetryForPlaybookTemplate does nothing.

func (*NoopTelemetry) ImportPlaybook

func (t *NoopTelemetry) ImportPlaybook(app.Playbook, string)

ImportPlaybook does nothing.

func (*NoopTelemetry) ModifyCheckedState

func (t *NoopTelemetry) ModifyCheckedState(string, string, app.ChecklistItem, bool)

ModifyCheckedState does nothing.

func (*NoopTelemetry) MoveChecklist

func (t *NoopTelemetry) MoveChecklist(string, string, app.Checklist)

MoveChecklist does nothing.

func (*NoopTelemetry) MoveTask

func (t *NoopTelemetry) MoveTask(string, string, app.ChecklistItem)

MoveTask does nothing.

func (*NoopTelemetry) NotifyAdmins

func (t *NoopTelemetry) NotifyAdmins(userID string, action string)

NotifyAdmins does nothing.

func (*NoopTelemetry) Page added in v1.34.0

func (t *NoopTelemetry) Page(name app.TelemetryPage, properties map[string]interface{})

Page does nothing

func (*NoopTelemetry) PublishRetrospective

func (t *NoopTelemetry) PublishRetrospective(playbookRun *app.PlaybookRun, userID string)

func (*NoopTelemetry) RemoveChecklist

func (t *NoopTelemetry) RemoveChecklist(playbookRunID, userID string, checklist app.Checklist)

RemoveChecklist does nothing

func (*NoopTelemetry) RemoveTask

func (t *NoopTelemetry) RemoveTask(string, string, app.ChecklistItem)

RemoveTask does nothing.

func (*NoopTelemetry) RemoveTimelineEvent

func (t *NoopTelemetry) RemoveTimelineEvent(*app.PlaybookRun, string)

RemoveTimelineEvent does nothing

func (*NoopTelemetry) RenameChecklist

func (t *NoopTelemetry) RenameChecklist(playbookRunID, userID string, checklist app.Checklist)

RenameChecklist does nothing

func (*NoopTelemetry) RenameTask

func (t *NoopTelemetry) RenameTask(string, string, app.ChecklistItem)

RenameTask does nothing.

func (*NoopTelemetry) RestartPlaybookRun

func (t *NoopTelemetry) RestartPlaybookRun(*app.PlaybookRun, string)

RestartPlaybookRun does nothing

func (*NoopTelemetry) RestoreChecklist added in v1.27.0

func (t *NoopTelemetry) RestoreChecklist(string, string, app.Checklist)

RestoreChecklist does nothing.

func (*NoopTelemetry) RestorePlaybook

func (t *NoopTelemetry) RestorePlaybook(app.Playbook, string)

RestorePlaybook does nothing either.

func (*NoopTelemetry) RestorePlaybookRun

func (t *NoopTelemetry) RestorePlaybookRun(*app.PlaybookRun, string)

RestorePlaybookRun does nothing

func (*NoopTelemetry) RestoreTask

func (t *NoopTelemetry) RestoreTask(string, string, app.ChecklistItem)

RestoreTask does nothing.

func (*NoopTelemetry) RunAction added in v1.28.0

func (t *NoopTelemetry) RunAction(playbookRun *app.PlaybookRun, userID, triggerType, actionType string, numBroadcasts int)

RunAction does nothing

func (*NoopTelemetry) RunChannelAction added in v1.26.0

func (t *NoopTelemetry) RunChannelAction(action app.GenericChannelAction, userID string)

RunChannelAction does nothing

func (*NoopTelemetry) RunTaskSlashCommand

func (t *NoopTelemetry) RunTaskSlashCommand(string, string, app.ChecklistItem)

RunTaskSlashCommand does nothing

func (*NoopTelemetry) SetAssignee

func (t *NoopTelemetry) SetAssignee(string, string, app.ChecklistItem)

SetAssignee does nothing.

func (*NoopTelemetry) SkipChecklist added in v1.27.0

func (t *NoopTelemetry) SkipChecklist(string, string, app.Checklist)

SkipChecklist does nothing.

func (*NoopTelemetry) SkipTask

func (t *NoopTelemetry) SkipTask(string, string, app.ChecklistItem)

SkipTask does nothing.

func (*NoopTelemetry) StartTrial

func (t *NoopTelemetry) StartTrial(userID string, action string)

StartTrial does nothing.

func (*NoopTelemetry) Track added in v1.34.0

func (t *NoopTelemetry) Track(name app.TelemetryTrack, properties map[string]interface{})

Track does nothing

func (*NoopTelemetry) UnfavoriteItem added in v1.31.0

func (t *NoopTelemetry) UnfavoriteItem(item app.CategoryItem, userID string)

UnfavoriteItem does nothing

func (*NoopTelemetry) Unfollow

func (t *NoopTelemetry) Unfollow(playbookRun *app.PlaybookRun, userID string)

Unfollow tracks userID following a playbook run.

func (*NoopTelemetry) UpdateChannelAction added in v1.29.0

func (t *NoopTelemetry) UpdateChannelAction(action app.GenericChannelAction, userID string)

UpdateChannelAction does nothing

func (*NoopTelemetry) UpdatePlaybook

func (t *NoopTelemetry) UpdatePlaybook(app.Playbook, string)

UpdatePlaybook does nothing.

func (*NoopTelemetry) UpdateRetrospective

func (t *NoopTelemetry) UpdateRetrospective(playbookRun *app.PlaybookRun, userID string)

func (*NoopTelemetry) UpdateStatus

func (t *NoopTelemetry) UpdateStatus(*app.PlaybookRun, string)

UpdateStatus does nothing

type RudderTelemetry

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

RudderTelemetry implements Telemetry using a Rudder backend.

func NewRudder

func NewRudder(dataPlaneURL, writeKey, diagnosticID, pluginVersion, serverVersion string) (*RudderTelemetry, error)

NewRudder builds a new RudderTelemetry client that will send the events to dataPlaneURL with the writeKey, identified with the diagnosticID. The version of the server is also sent with every event tracked. If either diagnosticID or serverVersion are empty, an error is returned.

func (*RudderTelemetry) AddChecklist

func (t *RudderTelemetry) AddChecklist(playbookRunID, userID string, checklist app.Checklist)

AddChecklist tracks the creation of a new checklist.

func (*RudderTelemetry) AddPostToTimeline

func (t *RudderTelemetry) AddPostToTimeline(playbookRun *app.PlaybookRun, userID string)

AddPostToTimeline tracks userID creating a timeline event from a post.

func (*RudderTelemetry) AddTask

func (t *RudderTelemetry) AddTask(playbookRunID, userID string, task app.ChecklistItem)

AddTask tracks the creation of a new checklist item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) AutoFollowPlaybook

func (t *RudderTelemetry) AutoFollowPlaybook(playbook app.Playbook, userID string)

AutoFollowPlaybook tracks the auto-follow of a playbook.

func (*RudderTelemetry) AutoUnfollowPlaybook

func (t *RudderTelemetry) AutoUnfollowPlaybook(playbook app.Playbook, userID string)

AutoUnfollowPlaybook tracks the auto-unfollow of a playbook.

func (*RudderTelemetry) ChangeDigestSettings

func (t *RudderTelemetry) ChangeDigestSettings(userID string, old app.DigestNotificationSettings, new app.DigestNotificationSettings)

ChangeDigestSettings tracks when a user changes one of the digest settings

func (*RudderTelemetry) ChangeOwner

func (t *RudderTelemetry) ChangeOwner(playbookRun *app.PlaybookRun, userID string)

ChangeOwner tracks changes in owner

func (*RudderTelemetry) CreatePlaybook

func (t *RudderTelemetry) CreatePlaybook(playbook app.Playbook, userID string)

CreatePlaybook tracks the creation of a playbook.

func (*RudderTelemetry) CreatePlaybookRun

func (t *RudderTelemetry) CreatePlaybookRun(playbookRun *app.PlaybookRun, userID string, public bool)

CreatePlaybookRun tracks the creation of the playbook run passed.

func (*RudderTelemetry) DeletePlaybook

func (t *RudderTelemetry) DeletePlaybook(playbook app.Playbook, userID string)

DeletePlaybook tracks the deletion of a playbook.

func (*RudderTelemetry) Disable

func (t *RudderTelemetry) Disable() error

Disable disables telemetry for all future events. It does nothing if the client is already disabled.

func (*RudderTelemetry) Enable

func (t *RudderTelemetry) Enable() error

Enable creates a new client to track all future events. It does nothing if a client is already enabled.

func (*RudderTelemetry) FavoriteItem added in v1.31.0

func (t *RudderTelemetry) FavoriteItem(item app.CategoryItem, userID string)

FavoriteItem tracks run favoriting of an item. Item can be run or a playbook

func (*RudderTelemetry) FinishPlaybookRun

func (t *RudderTelemetry) FinishPlaybookRun(playbookRun *app.PlaybookRun, userID string)

FinishPlaybookRun tracks the end of the playbook run passed.

func (*RudderTelemetry) Follow

func (t *RudderTelemetry) Follow(playbookRun *app.PlaybookRun, userID string)

Follow tracks userID following a playbook run.

func (*RudderTelemetry) FrontendTelemetryForPlaybook

func (t *RudderTelemetry) FrontendTelemetryForPlaybook(playbook app.Playbook, userID, action string)

FrontendTelemetryForPlaybook tracks an event originating from the frontend

func (*RudderTelemetry) FrontendTelemetryForPlaybookRun

func (t *RudderTelemetry) FrontendTelemetryForPlaybookRun(playbookRun *app.PlaybookRun, userID, action string)

func (*RudderTelemetry) FrontendTelemetryForPlaybookTemplate

func (t *RudderTelemetry) FrontendTelemetryForPlaybookTemplate(templateName string, userID, action string)

FrontendTelemetryForPlaybookTemplate tracks a playbook template event originating from the frontend

func (*RudderTelemetry) ImportPlaybook

func (t *RudderTelemetry) ImportPlaybook(playbook app.Playbook, userID string)

ImportPlaybook tracks the import of a playbook.

func (*RudderTelemetry) ModifyCheckedState

func (t *RudderTelemetry) ModifyCheckedState(playbookRunID, userID string, task app.ChecklistItem, wasOwner bool)

ModifyCheckedState tracks the checking and unchecking of items by the user identified by userID in the given playbook run.

func (*RudderTelemetry) MoveChecklist

func (t *RudderTelemetry) MoveChecklist(playbookRunID, userID string, checklist app.Checklist)

MoveChecklist tracks the movement of a checklist

func (*RudderTelemetry) MoveTask

func (t *RudderTelemetry) MoveTask(playbookRunID, userID string, task app.ChecklistItem)

MoveTask tracks the movement of checklist items by the user identified by userID in the given playbook run.

func (*RudderTelemetry) NotifyAdmins

func (t *RudderTelemetry) NotifyAdmins(userID string, action string)

func (*RudderTelemetry) Page added in v1.34.0

func (t *RudderTelemetry) Page(name app.TelemetryPage, properties map[string]interface{})

Page is the generic tracker for pageviews to rudderstack

func (*RudderTelemetry) PublishRetrospective

func (t *RudderTelemetry) PublishRetrospective(playbookRun *app.PlaybookRun, userID string)

func (*RudderTelemetry) RemoveChecklist

func (t *RudderTelemetry) RemoveChecklist(playbookRunID, userID string, checklist app.Checklist)

RemoveChecklist tracks the removal of a checklist.

func (*RudderTelemetry) RemoveTask

func (t *RudderTelemetry) RemoveTask(playbookRunID, userID string, task app.ChecklistItem)

RemoveTask tracks the removal of a checklist item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) RemoveTimelineEvent

func (t *RudderTelemetry) RemoveTimelineEvent(playbookRun *app.PlaybookRun, userID string)

RemoveTimelineEvent tracks userID removing a timeline event.

func (*RudderTelemetry) RenameChecklist

func (t *RudderTelemetry) RenameChecklist(playbookRunID, userID string, checklist app.Checklist)

RenameChecklist tracks the renaming of a checklist

func (*RudderTelemetry) RenameTask

func (t *RudderTelemetry) RenameTask(playbookRunID, userID string, task app.ChecklistItem)

RenameTask tracks the update of a checklist item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) RestartPlaybookRun

func (t *RudderTelemetry) RestartPlaybookRun(playbookRun *app.PlaybookRun, userID string)

RestartPlaybookRun tracks the restart of the playbook run.

func (*RudderTelemetry) RestoreChecklist added in v1.27.0

func (t *RudderTelemetry) RestoreChecklist(playbookRunID, userID string, checklist app.Checklist)

RestoreChecklist tracks the restoring of a checklist by the user identified by userID in the given playbook run.

func (*RudderTelemetry) RestorePlaybook

func (t *RudderTelemetry) RestorePlaybook(playbook app.Playbook, userID string)

RestorePlaybook tracks the deletion of a playbook.

func (*RudderTelemetry) RestorePlaybookRun

func (t *RudderTelemetry) RestorePlaybookRun(playbookRun *app.PlaybookRun, userID string)

RestorePlaybookRun tracks the restoration of the playbook run.

func (*RudderTelemetry) RestoreTask

func (t *RudderTelemetry) RestoreTask(playbookRunID, userID string, task app.ChecklistItem)

RestoreTask tracks the restoring of a checklist item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) RunAction added in v1.28.0

func (t *RudderTelemetry) RunAction(playbookRun *app.PlaybookRun, userID, triggerType, actionType string, numBroadcasts int)

RunAction tracks the run actions, i.e., status broadcast action

func (*RudderTelemetry) RunChannelAction added in v1.26.0

func (t *RudderTelemetry) RunChannelAction(action app.GenericChannelAction, userID string)

func (*RudderTelemetry) RunTaskSlashCommand

func (t *RudderTelemetry) RunTaskSlashCommand(playbookRunID, userID string, task app.ChecklistItem)

RunTaskSlashCommand tracks the execution of a slash command on a checklist item.

func (*RudderTelemetry) SetAssignee

func (t *RudderTelemetry) SetAssignee(playbookRunID, userID string, task app.ChecklistItem)

SetAssignee tracks the changing of an assignee on an item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) SkipChecklist added in v1.27.0

func (t *RudderTelemetry) SkipChecklist(playbookRunID, userID string, checklist app.Checklist)

SkipChecklist tracks the skipping of a checklist by the user identified by userID in the given playbook run.

func (*RudderTelemetry) SkipTask

func (t *RudderTelemetry) SkipTask(playbookRunID, userID string, task app.ChecklistItem)

SkipTask tracks the skipping of a checklist item by the user identified by userID in the given playbook run.

func (*RudderTelemetry) StartTrial

func (t *RudderTelemetry) StartTrial(userID string, action string)

func (*RudderTelemetry) Track added in v1.34.0

func (t *RudderTelemetry) Track(name app.TelemetryTrack, properties map[string]interface{})

Track is the generic tracker for events to rudderstack

func (*RudderTelemetry) UnfavoriteItem added in v1.31.0

func (t *RudderTelemetry) UnfavoriteItem(item app.CategoryItem, userID string)

UnfavoriteItem tracks run unfavoriting of an item. Item can be run or a playbook

func (*RudderTelemetry) Unfollow

func (t *RudderTelemetry) Unfollow(playbookRun *app.PlaybookRun, userID string)

Unfollow tracks userID following a playbook run.

func (*RudderTelemetry) UpdateChannelAction added in v1.29.0

func (t *RudderTelemetry) UpdateChannelAction(action app.GenericChannelAction, userID string)

UpdateRunActions tracks actions settings update

func (*RudderTelemetry) UpdatePlaybook

func (t *RudderTelemetry) UpdatePlaybook(playbook app.Playbook, userID string)

UpdatePlaybook tracks the update of a playbook.

func (*RudderTelemetry) UpdateRetrospective

func (t *RudderTelemetry) UpdateRetrospective(playbookRun *app.PlaybookRun, userID string)

func (*RudderTelemetry) UpdateStatus

func (t *RudderTelemetry) UpdateStatus(playbookRun *app.PlaybookRun, userID string)

Jump to

Keyboard shortcuts

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