usagereporter

package
v0.0.0-...-5c79d48 Latest Latest
Warning

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

 Go to latest Published: Feb 15, 2024 License: AGPL-3.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// TCPSessionType is the session_type in tp.session.start for TCP
	// Application Access.
	TCPSessionType = "app_tcp"
	// PortSessionType is the session_type in tp.session.start for SSH or Kube
	// port forwarding.
	//
	// Deprecated: used in older versions to mean either SSH or Kube. Use
	// PortSSHSessionType or PortKubeSessionType instead.
	PortSessionType = "ssh_port"
	// PortSSHSessionType is the session_type in tp.session.start for SSH port
	// forwarding.
	PortSSHSessionType = "ssh_port_v2"
	// PortKubeSessionType is the session_type in tp.session.start for Kube port
	// forwarding.
	PortKubeSessionType = "k8s_port"
)
View Source 
const (
	ResourceKindNode            = prehogv1a.ResourceKind_RESOURCE_KIND_NODE
	ResourceKindAppServer       = prehogv1a.ResourceKind_RESOURCE_KIND_APP_SERVER
	ResourceKindKubeServer      = prehogv1a.ResourceKind_RESOURCE_KIND_KUBE_SERVER
	ResourceKindDBServer        = prehogv1a.ResourceKind_RESOURCE_KIND_DB_SERVER
	ResourceKindWindowsDesktop  = prehogv1a.ResourceKind_RESOURCE_KIND_WINDOWS_DESKTOP
	ResourceKindNodeOpenSSH     = prehogv1a.ResourceKind_RESOURCE_KIND_NODE_OPENSSH
	ResourceKindNodeOpenSSHEICE = prehogv1a.ResourceKind_RESOURCE_KIND_NODE_OPENSSH_EICE
)

Variables

This section is empty.

Functions

func EmitEditorChangeEvent 

func EmitEditorChangeEvent(username string, prevRoles, newRoles []string, submit func(...Anonymizable))

EmitEditorChangeEvent emits an editor change event if the editor role was added or removed.

Types

type AccessListCreateEvent 

type AccessListCreateEvent prehogv1a.AccessListCreateEvent

func (*AccessListCreateEvent) Anonymize 

func (e *AccessListCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListDeleteEvent 

type AccessListDeleteEvent prehogv1a.AccessListDeleteEvent

func (*AccessListDeleteEvent) Anonymize 

func (e *AccessListDeleteEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListGrantsToUserEvent 

type AccessListGrantsToUserEvent prehogv1a.AccessListGrantsToUserEvent

func (*AccessListGrantsToUserEvent) Anonymize 

func (e *AccessListGrantsToUserEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListMemberCreateEvent 

type AccessListMemberCreateEvent prehogv1a.AccessListMemberCreateEvent

func (*AccessListMemberCreateEvent) Anonymize 

func (e *AccessListMemberCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListMemberDeleteEvent 

type AccessListMemberDeleteEvent prehogv1a.AccessListMemberDeleteEvent

func (*AccessListMemberDeleteEvent) Anonymize 

func (e *AccessListMemberDeleteEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListMemberUpdateEvent 

type AccessListMemberUpdateEvent prehogv1a.AccessListMemberUpdateEvent

func (*AccessListMemberUpdateEvent) Anonymize 

func (e *AccessListMemberUpdateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListReviewComplianceEvent 

type AccessListReviewComplianceEvent prehogv1a.AccessListReviewComplianceEvent

func (*AccessListReviewComplianceEvent) Anonymize 

func (e *AccessListReviewComplianceEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListReviewCreateEvent 

type AccessListReviewCreateEvent prehogv1a.AccessListReviewCreateEvent

func (*AccessListReviewCreateEvent) Anonymize 

func (e *AccessListReviewCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListReviewDeleteEvent 

type AccessListReviewDeleteEvent prehogv1a.AccessListReviewDeleteEvent

func (*AccessListReviewDeleteEvent) Anonymize 

func (e *AccessListReviewDeleteEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AccessListUpdateEvent 

type AccessListUpdateEvent prehogv1a.AccessListUpdateEvent

func (*AccessListUpdateEvent) Anonymize 

func (e *AccessListUpdateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AgentMetadataEvent 

type AgentMetadataEvent prehogv1a.AgentMetadataEvent

AgentMetadataEvent is an event emitted after an agent first connects to the auth server.

func (*AgentMetadataEvent) Anonymize 

func (u *AgentMetadataEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type Anonymizable 

type Anonymizable interface {
	// Anonymize uses the given anonymizer to anonymize the event and converts
	// it into a partially filled SubmitEventRequest.
	Anonymize(utils.Anonymizer) prehogv1a.SubmitEventRequest
}

Anonymizable is an event that can be anonymized.

func ConvertAuditEvent 

func ConvertAuditEvent(event apievents.AuditEvent) Anonymizable

func ConvertUsageEvent 

func ConvertUsageEvent(event *usageeventsv1.UsageEventOneOf, userMD UserMetadata) (Anonymizable, error)

ConvertUsageEvent converts a usage event from an API object into an anonymizable event. All events that can be submitted externally via the Auth API need to be defined here.

type AssistAccessRequestEvent 

type AssistAccessRequestEvent prehogv1a.AssistAccessRequestEvent

func (*AssistAccessRequestEvent) Anonymize 

func (e *AssistAccessRequestEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AssistActionEvent 

type AssistActionEvent prehogv1a.AssistActionEvent

func (*AssistActionEvent) Anonymize 

func (e *AssistActionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type AssistCompletionEvent 

type AssistCompletionEvent prehogv1a.AssistCompletionEvent

AssistCompletionEvent is an event emitted after each completion by the Assistant

func (*AssistCompletionEvent) Anonymize 

func (e *AssistCompletionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type AssistExecutionEvent 

type AssistExecutionEvent prehogv1a.AssistExecutionEvent

func (*AssistExecutionEvent) Anonymize 

func (e *AssistExecutionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type AssistNewConversationEvent 

type AssistNewConversationEvent prehogv1a.AssistNewConversationEvent

func (*AssistNewConversationEvent) Anonymize 

func (e *AssistNewConversationEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type AuditQueryRunEvent 

type AuditQueryRunEvent prehogv1a.AuditQueryRunEvent

AuditQueryRunEvent is emitted when a user runs an audit query.

func (*AuditQueryRunEvent) Anonymize 

func (e *AuditQueryRunEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event. Since there is nothing to anonymize, it really just wraps itself in a prehogv1a.SubmitEventRequest.

type BotCreateEvent 

type BotCreateEvent prehogv1a.BotCreateEvent

BotCreateEvent is an event emitted when a Machine ID bot is created.

func (*BotCreateEvent) Anonymize 

func (u *BotCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type BotJoinEvent 

type BotJoinEvent prehogv1a.BotJoinEvent

BotJoinEvent is an event emitted when a user logs into Teleport, potentially via SSO.

func (*BotJoinEvent) Anonymize 

func (u *BotJoinEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type DesktopClipboardEvent 

type DesktopClipboardEvent prehogv1a.DesktopClipboardEvent

DesktopClipboardEvent is emitted when a user transfers data between their local clipboard and the clipboard on a remote Windows desktop.

func (*DesktopClipboardEvent) Anonymize 

func (e *DesktopClipboardEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type DesktopDirectoryShareEvent 

type DesktopDirectoryShareEvent prehogv1a.DesktopDirectoryShareEvent

DesktopDirectoryShareEvent is emitted when a user shares a directory in a Windows desktop session.

func (*DesktopDirectoryShareEvent) Anonymize 

func (e *DesktopDirectoryShareEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type DeviceAuthenticateEvent 

type DeviceAuthenticateEvent prehogv1a.DeviceAuthenticateEvent

DeviceAuthenticateEvent event is emitted after a successful device authentication ceremony.

func (*DeviceAuthenticateEvent) Anonymize 

func (d *DeviceAuthenticateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type DeviceEnrollEvent 

type DeviceEnrollEvent prehogv1a.DeviceEnrollEvent

DeviceEnrollEvent event is emitted after a successful device enrollment.

func (*DeviceEnrollEvent) Anonymize 

func (d *DeviceEnrollEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type DiscardUsageReporter 

type DiscardUsageReporter struct{}

DiscardUsageReporter is a dummy usage reporter that drops all events.

func (DiscardUsageReporter) AnonymizeAndSubmit 

func (DiscardUsageReporter) AnonymizeAndSubmit(...Anonymizable)

AnonymizeAndSubmit implements UsageReporter

type DiscoveryFetchEvent 

type DiscoveryFetchEvent prehogv1a.DiscoveryFetchEvent

DiscoveryFetchEvent is emitted when a DiscoveryService fetchs resources.

func (*DiscoveryFetchEvent) Anonymize 

func (e *DiscoveryFetchEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type EditorChangeEvent 

type EditorChangeEvent prehogv1a.EditorChangeEvent

EditorChangeEvent is an event emitted when the default editor is added or removed to an user

func (*EditorChangeEvent) Anonymize 

func (e *EditorChangeEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type ExternalAuditStorageAuthenticateEvent 

type ExternalAuditStorageAuthenticateEvent prehogv1a.ExternalAuditStorageAuthenticateEvent

ExternalAuditStorageAuthenticateEvent is emitted when the External Audit Storage feature authenticates to the customer AWS account via OIDC connector. The purpose is to have a regularly emitted event indicating that the External Audit Storage feature is still in use.

func (*ExternalAuditStorageAuthenticateEvent) Anonymize 

func (e *ExternalAuditStorageAuthenticateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event. Since there is nothing to anonymize, it really just wraps itself in a prehogv1a.SubmitEventRequest.

type FeatureRecommendationEvent 

type FeatureRecommendationEvent prehogv1a.FeatureRecommendationEvent

FeatureRecommendationEvent emitted when a feature is recommended to user or when user completes the desired CTA for the feature.

func (*FeatureRecommendationEvent) Anonymize 

func (e *FeatureRecommendationEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type GracefulStopper 

type GracefulStopper interface {
	UsageReporter

	// GracefulStop gracefully closes and runs any finalization needed by the
	// UsageReporter; operations can run as long as the context is alive, but
	// must terminate quickly (even losing data) if the context is closed.
	// Returns nil if operations have completed cleanly.
	GracefulStop(context.Context) error
}

GracefulStopper is a UsageReporter that needs to do some work before stopping; this is a separate interface because UsageReporter is embedded in auth.Server.Services, and we don't want to expose extraneous methods as part of auth.Server.

type KubeRequestEvent 

type KubeRequestEvent prehogv1a.KubeRequestEvent

KubeRequestEvent is an event emitted when a Kubernetes API request is handled.

func (*KubeRequestEvent) Anonymize 

func (u *KubeRequestEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type LicenseLimitEvent 

type LicenseLimitEvent prehogv1a.LicenseLimitEvent

LicenseLimitEvent emitted when a feature is gated behind enterprise license.

func (*LicenseLimitEvent) Anonymize 

func (e *LicenseLimitEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type MFAAuthenticationEvent 

type MFAAuthenticationEvent prehogv1a.MFAAuthenticationEvent

MFAAuthenticationEvent is emitted when a user performs MFA authentication.

func (*MFAAuthenticationEvent) Anonymize 

func (e *MFAAuthenticationEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type OktaAccessListSyncEvent 

type OktaAccessListSyncEvent prehogv1a.OktaAccessListSyncEvent

OktaAccessListSyncEvent is emitted when the Okta service syncs access lists from Okta.

func (*OktaAccessListSyncEvent) Anonymize 

func (u *OktaAccessListSyncEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type ResourceCreateEvent 

type ResourceCreateEvent prehogv1a.ResourceCreateEvent

ResourceCreateEvent is an event emitted when various resource types have been created.

func (*ResourceCreateEvent) Anonymize 

func (u *ResourceCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type ResourceHeartbeatEvent 

type ResourceHeartbeatEvent struct {
	Name   string
	Kind   prehogv1a.ResourceKind
	Static bool
}

func (*ResourceHeartbeatEvent) Anonymize 

func (u *ResourceHeartbeatEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type ResourceKind 

type ResourceKind = prehogv1a.ResourceKind

func ResourceKindFromKeepAliveType 

func ResourceKindFromKeepAliveType(t types.KeepAlive_KeepAliveType) ResourceKind

type RoleCreateEvent 

type RoleCreateEvent prehogv1a.RoleCreateEvent

RoleCreateEvent is an event emitted when a custom role is created.

func (*RoleCreateEvent) Anonymize 

func (u *RoleCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type SFTPEvent 

type SFTPEvent prehogv1a.SFTPEvent

SFTPEvent is an event emitted for each file operation in a SFTP connection.

func (*SFTPEvent) Anonymize 

func (u *SFTPEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type SPIFFESVIDIssuedEvent 

type SPIFFESVIDIssuedEvent prehogv1a.SPIFFESVIDIssuedEvent

SPIFFESVIDIssuedEvent is an event emitted when a SPIFFE SVID has been issued.

func (*SPIFFESVIDIssuedEvent) Anonymize 

func (u *SPIFFESVIDIssuedEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type SSOCreateEvent 

type SSOCreateEvent prehogv1a.SSOCreateEvent

SSOCreateEvent is emitted when an SSO connector has been created.

func (*SSOCreateEvent) Anonymize 

func (u *SSOCreateEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type SecurityReportGetResultEvent 

type SecurityReportGetResultEvent prehogv1a.SecurityReportGetResultEvent

SecurityReportGetResultEvent is emitted when a user requests a security report.

func (*SecurityReportGetResultEvent) Anonymize 

func (e *SecurityReportGetResultEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event. Since there is nothing to anonymize, it really just wraps itself in a prehogv1a.SubmitEventRequest.

type SessionStartEvent 

type SessionStartEvent prehogv1a.SessionStartEvent

SessionStartEvent is an event emitted when some Teleport session has started (ssh, etc).

func (*SessionStartEvent) Anonymize 

func (u *SessionStartEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type StreamingUsageReporter 

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

StreamingUsageReporter submits all Teleport usage events anonymized with the cluster name, with a very short buffer for batches and no persistency.

func NewStreamingUsageReporter 

func NewStreamingUsageReporter(log logrus.FieldLogger, clusterName types.ClusterName, anonymizationKey string, submitter SubmitFunc) (*StreamingUsageReporter, error)

func (*StreamingUsageReporter) AnonymizeAndSubmit 

func (t *StreamingUsageReporter) AnonymizeAndSubmit(events ...Anonymizable)

func (*StreamingUsageReporter) Run 

func (t *StreamingUsageReporter) Run(ctx context.Context)

type SubmitFunc 

type SubmitFunc = usagereporter.SubmitFunc[prehogv1a.SubmitEventRequest]

func NewPrehogSubmitter 

func NewPrehogSubmitter(ctx context.Context, prehogEndpoint string, clientCert *tls.Certificate, caCertPEM []byte) (SubmitFunc, error)

type TagExecuteQueryEvent 

type TagExecuteQueryEvent prehogv1a.TAGExecuteQueryEvent

func (*TagExecuteQueryEvent) Anonymize 

func (e *TagExecuteQueryEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

Anonymize anonymizes the event.

type UIBannerClickEvent 

type UIBannerClickEvent prehogv1a.UIBannerClickEvent

UIBannerClickEvent is a UI event sent when a banner is clicked.

func (*UIBannerClickEvent) Anonymize 

func (u *UIBannerClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UICallToActionClickEvent 

type UICallToActionClickEvent prehogv1a.UICallToActionClickEvent

UICallToActionClickEvent is a UI event sent when a user prints recovery codes.

func (*UICallToActionClickEvent) Anonymize 

func (u *UICallToActionClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UICreateNewRoleCancelClickEvent 

type UICreateNewRoleCancelClickEvent prehogv1a.UICreateNewRoleCancelClickEvent

UICreateNewRoleCancelClickEvent is a UI event sent when a user prints recovery codes.

func (*UICreateNewRoleCancelClickEvent) Anonymize 

func (u *UICreateNewRoleCancelClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UICreateNewRoleClickEvent 

type UICreateNewRoleClickEvent prehogv1a.UICreateNewRoleClickEvent

UICreateNewRoleClickEvent is a UI event sent when a user prints recovery codes.

func (*UICreateNewRoleClickEvent) Anonymize 

func (u *UICreateNewRoleClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UICreateNewRoleSaveClickEvent 

type UICreateNewRoleSaveClickEvent prehogv1a.UICreateNewRoleSaveClickEvent

UICreateNewRoleSaveClickEvent is a UI event sent when a user prints recovery codes.

func (*UICreateNewRoleSaveClickEvent) Anonymize 

func (u *UICreateNewRoleSaveClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UICreateNewRoleViewDocumentationClickEvent 

type UICreateNewRoleViewDocumentationClickEvent prehogv1a.UICreateNewRoleViewDocumentationClickEvent

UICreateNewRoleViewDocumentationClickEvent is a UI event sent when a user prints recovery codes.

func (*UICreateNewRoleViewDocumentationClickEvent) Anonymize 

func (u *UICreateNewRoleViewDocumentationClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIDiscoverAutoDiscoveredResourcesEvent 

type UIDiscoverAutoDiscoveredResourcesEvent prehogv1a.UIDiscoverAutoDiscoveredResourcesEvent

UIDiscoverAutoDiscoveredResourcesEvent is emitted when the user is presented with the list of auto discovered resources. resources_count field must contain the number of discovered resources when the user leaves the screen.

func (*UIDiscoverAutoDiscoveredResourcesEvent) Anonymize 

func (u *UIDiscoverAutoDiscoveredResourcesEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverAutoDiscoveredResourcesEvent) CheckAndSetDefaults 

func (u *UIDiscoverAutoDiscoveredResourcesEvent) CheckAndSetDefaults() error

type UIDiscoverCompletedEvent 

type UIDiscoverCompletedEvent prehogv1a.UIDiscoverCompletedEvent

UIDiscoverCompletedEvent is emitted when user completes the Discover wizard.

func (*UIDiscoverCompletedEvent) Anonymize 

func (u *UIDiscoverCompletedEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverCompletedEvent) CheckAndSetDefaults 

func (u *UIDiscoverCompletedEvent) CheckAndSetDefaults() error

type UIDiscoverCreateNodeEvent 

type UIDiscoverCreateNodeEvent prehogv1a.UIDiscoverCreateNodeEvent

UIDiscoverCreateNodeEvent is emitted when the node is created in Teleport.

func (*UIDiscoverCreateNodeEvent) Anonymize 

func (u *UIDiscoverCreateNodeEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverCreateNodeEvent) CheckAndSetDefaults 

func (u *UIDiscoverCreateNodeEvent) CheckAndSetDefaults() error

type UIDiscoverDatabaseConfigureIAMPolicyEvent 

type UIDiscoverDatabaseConfigureIAMPolicyEvent prehogv1a.UIDiscoverDatabaseConfigureIAMPolicyEvent

UIDiscoverDatabaseConfigureIAMPolicyEvent is emitted when a user configured IAM for RDS database and proceeded to the next step.

func (*UIDiscoverDatabaseConfigureIAMPolicyEvent) Anonymize 

func (u *UIDiscoverDatabaseConfigureIAMPolicyEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDatabaseConfigureIAMPolicyEvent) CheckAndSetDefaults 

func (u *UIDiscoverDatabaseConfigureIAMPolicyEvent) CheckAndSetDefaults() error

type UIDiscoverDatabaseConfigureMTLSEvent 

type UIDiscoverDatabaseConfigureMTLSEvent prehogv1a.UIDiscoverDatabaseConfigureMTLSEvent

UIDiscoverDatabaseConfigureMTLSEvent is emitted when a user configures mutual TLS for self-hosted database and goes to the next step.

func (*UIDiscoverDatabaseConfigureMTLSEvent) Anonymize 

func (u *UIDiscoverDatabaseConfigureMTLSEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDatabaseConfigureMTLSEvent) CheckAndSetDefaults 

func (u *UIDiscoverDatabaseConfigureMTLSEvent) CheckAndSetDefaults() error

type UIDiscoverDatabaseRDSEnrollEvent 

type UIDiscoverDatabaseRDSEnrollEvent prehogv1a.UIDiscoverDatabaseRDSEnrollEvent

UIDiscoverDatabaseRDSEnrollEvent is emitted when a user is finished with the step that asks user to select from a list of RDS databases.

func (*UIDiscoverDatabaseRDSEnrollEvent) Anonymize 

func (u *UIDiscoverDatabaseRDSEnrollEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDatabaseRDSEnrollEvent) CheckAndSetDefaults 

func (u *UIDiscoverDatabaseRDSEnrollEvent) CheckAndSetDefaults() error

type UIDiscoverDatabaseRegisterEvent 

type UIDiscoverDatabaseRegisterEvent prehogv1a.UIDiscoverDatabaseRegisterEvent

UIDiscoverDatabaseRegisterEvent is emitted when a user registers a database resource and goes to the next step.

func (*UIDiscoverDatabaseRegisterEvent) Anonymize 

func (u *UIDiscoverDatabaseRegisterEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDatabaseRegisterEvent) CheckAndSetDefaults 

func (u *UIDiscoverDatabaseRegisterEvent) CheckAndSetDefaults() error

type UIDiscoverDeployEICEEvent 

type UIDiscoverDeployEICEEvent prehogv1a.UIDiscoverDeployEICEEvent

UIDiscoverDeployEICEEvent is emitted when the user deploys an EC2 Instance Connect Endpoint.

func (*UIDiscoverDeployEICEEvent) Anonymize 

func (u *UIDiscoverDeployEICEEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDeployEICEEvent) CheckAndSetDefaults 

func (u *UIDiscoverDeployEICEEvent) CheckAndSetDefaults() error

type UIDiscoverDeployServiceEvent 

type UIDiscoverDeployServiceEvent prehogv1a.UIDiscoverDeployServiceEvent

UIDiscoverDeployServiceEvent is emitted after the user installs a Teleport Agent. For SSH this is the Teleport 'install-node' script.

For Kubernetes this is the teleport-agent helm chart installation.

For Database Access this step is the installation of the teleport 'install-db' script. It can be skipped if the cluster already has a Database Service capable of proxying the database.

func (*UIDiscoverDeployServiceEvent) Anonymize 

func (u *UIDiscoverDeployServiceEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDeployServiceEvent) CheckAndSetDefaults 

func (u *UIDiscoverDeployServiceEvent) CheckAndSetDefaults() error

type UIDiscoverDesktopActiveDirectoryConfigureEvent 

type UIDiscoverDesktopActiveDirectoryConfigureEvent prehogv1a.UIDiscoverDesktopActiveDirectoryConfigureEvent

UIDiscoverDesktopActiveDirectoryConfigureEvent is emitted when the user is asked to run the Configure Active Directory script. This happens on the Desktop flow.

func (*UIDiscoverDesktopActiveDirectoryConfigureEvent) Anonymize 

func (u *UIDiscoverDesktopActiveDirectoryConfigureEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDesktopActiveDirectoryConfigureEvent) CheckAndSetDefaults 

func (u *UIDiscoverDesktopActiveDirectoryConfigureEvent) CheckAndSetDefaults() error

type UIDiscoverDesktopActiveDirectoryToolsInstallEvent 

type UIDiscoverDesktopActiveDirectoryToolsInstallEvent prehogv1a.UIDiscoverDesktopActiveDirectoryToolsInstallEvent

UIDiscoverDesktopActiveDirectoryToolsInstallEvent is emitted when the user is asked to run the install Active Directory tools script. This happens on the Desktop flow.

func (*UIDiscoverDesktopActiveDirectoryToolsInstallEvent) Anonymize 

func (u *UIDiscoverDesktopActiveDirectoryToolsInstallEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverDesktopActiveDirectoryToolsInstallEvent) CheckAndSetDefaults 

func (u *UIDiscoverDesktopActiveDirectoryToolsInstallEvent) CheckAndSetDefaults() error

type UIDiscoverEC2InstanceSelectionEvent 

type UIDiscoverEC2InstanceSelectionEvent prehogv1a.UIDiscoverEC2InstanceSelectionEvent

UIDiscoverEC2InstanceSelectionEvent is emitted when the user is finished with the step that asks the user to select an EC2 Instance to enroll.

func (*UIDiscoverEC2InstanceSelectionEvent) Anonymize 

func (u *UIDiscoverEC2InstanceSelectionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverEC2InstanceSelectionEvent) CheckAndSetDefaults 

func (u *UIDiscoverEC2InstanceSelectionEvent) CheckAndSetDefaults() error

type UIDiscoverIntegrationAWSOIDCConnectEvent 

type UIDiscoverIntegrationAWSOIDCConnectEvent prehogv1a.UIDiscoverIntegrationAWSOIDCConnectEvent

UIDiscoverIntegrationAWSOIDCConnectEvent is emitted when a user is finished with the step that asks user to setup aws integration or select from a list of existing aws integrations.

func (*UIDiscoverIntegrationAWSOIDCConnectEvent) Anonymize 

func (u *UIDiscoverIntegrationAWSOIDCConnectEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverIntegrationAWSOIDCConnectEvent) CheckAndSetDefaults 

func (u *UIDiscoverIntegrationAWSOIDCConnectEvent) CheckAndSetDefaults() error

type UIDiscoverPrincipalsConfigureEvent 

type UIDiscoverPrincipalsConfigureEvent prehogv1a.UIDiscoverPrincipalsConfigureEvent

UIDiscoverPrincipalsConfigureEvent emitted on "Setup Access" screen when user has updated their principals and proceeded to the next step.

func (*UIDiscoverPrincipalsConfigureEvent) Anonymize 

func (u *UIDiscoverPrincipalsConfigureEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverPrincipalsConfigureEvent) CheckAndSetDefaults 

func (u *UIDiscoverPrincipalsConfigureEvent) CheckAndSetDefaults() error

type UIDiscoverResourceSelectionEvent 

type UIDiscoverResourceSelectionEvent prehogv1a.UIDiscoverResourceSelectionEvent

UIDiscoverResourceSelectionEvent is a UI event sent when a user starts the Discover Wizard.

func (*UIDiscoverResourceSelectionEvent) Anonymize 

func (u *UIDiscoverResourceSelectionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverResourceSelectionEvent) CheckAndSetDefaults 

func (u *UIDiscoverResourceSelectionEvent) CheckAndSetDefaults() error

type UIDiscoverStartedEvent 

type UIDiscoverStartedEvent prehogv1a.UIDiscoverStartedEvent

UIDiscoverStartedEvent is a UI event sent when a user starts the Discover Wizard.

func (*UIDiscoverStartedEvent) Anonymize 

func (u *UIDiscoverStartedEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverStartedEvent) CheckAndSetDefaults 

func (u *UIDiscoverStartedEvent) CheckAndSetDefaults() error

type UIDiscoverTestConnectionEvent 

type UIDiscoverTestConnectionEvent prehogv1a.UIDiscoverTestConnectionEvent

UIDiscoverTestConnectionEvent emitted on the "Test Connection" screen when the user clicked tested connection to their resource.

func (*UIDiscoverTestConnectionEvent) Anonymize 

func (u *UIDiscoverTestConnectionEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIDiscoverTestConnectionEvent) CheckAndSetDefaults 

func (u *UIDiscoverTestConnectionEvent) CheckAndSetDefaults() error

type UIIntegrationEnrollCompleteEvent 

type UIIntegrationEnrollCompleteEvent prehogv1a.UIIntegrationEnrollCompleteEvent

UIIntegrationEnrollCompleteEvent is a UI event sent when a user completes enrolling an integration.

func (*UIIntegrationEnrollCompleteEvent) Anonymize 

func (u *UIIntegrationEnrollCompleteEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIIntegrationEnrollCompleteEvent) CheckAndSetDefaults 

func (u *UIIntegrationEnrollCompleteEvent) CheckAndSetDefaults() error

type UIIntegrationEnrollStartEvent 

type UIIntegrationEnrollStartEvent prehogv1a.UIIntegrationEnrollStartEvent

UIIntegrationEnrollStartEvent is a UI event sent when a user starts enrolling a integration.

func (*UIIntegrationEnrollStartEvent) Anonymize 

func (u *UIIntegrationEnrollStartEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

func (*UIIntegrationEnrollStartEvent) CheckAndSetDefaults 

func (u *UIIntegrationEnrollStartEvent) CheckAndSetDefaults() error

type UIOnboardAddFirstResourceClickEvent 

type UIOnboardAddFirstResourceClickEvent prehogv1a.UIOnboardAddFirstResourceClickEvent

UIOnboardAddFirstResourceClickEvent is a UI event sent when a user clicks the "add first resource" button.

func (*UIOnboardAddFirstResourceClickEvent) Anonymize 

func (u *UIOnboardAddFirstResourceClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIOnboardAddFirstResourceLaterClickEvent 

type UIOnboardAddFirstResourceLaterClickEvent prehogv1a.UIOnboardAddFirstResourceLaterClickEvent

UIOnboardAddFirstResourceLaterClickEvent is a UI event sent when a user clicks the "add first resource later" button.

func (*UIOnboardAddFirstResourceLaterClickEvent) Anonymize 

func (u *UIOnboardAddFirstResourceLaterClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIOnboardCompleteGoToDashboardClickEvent 

type UIOnboardCompleteGoToDashboardClickEvent prehogv1a.UIOnboardCompleteGoToDashboardClickEvent

UIOnboardCompleteGoToDashboardClickEvent is a UI event sent when onboarding is complete.

func (*UIOnboardCompleteGoToDashboardClickEvent) Anonymize 

func (u *UIOnboardCompleteGoToDashboardClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIOnboardQuestionnaireSubmitEvent 

type UIOnboardQuestionnaireSubmitEvent prehogv1a.UIOnboardQuestionnaireSubmitEvent

UIOnboardQuestionnaireSubmitEvent is a UI event sent during registration when user submit their onboarding questionnaire.

func (*UIOnboardQuestionnaireSubmitEvent) Anonymize 

func (u *UIOnboardQuestionnaireSubmitEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIOnboardRegisterChallengeSubmitEvent 

type UIOnboardRegisterChallengeSubmitEvent prehogv1a.UIOnboardRegisterChallengeSubmitEvent

UIOnboardRegisterChallengeSubmitEvent is a UI event sent during registration when the MFA challenge is completed.

func (*UIOnboardRegisterChallengeSubmitEvent) Anonymize 

func (u *UIOnboardRegisterChallengeSubmitEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIOnboardSetCredentialSubmitEvent 

type UIOnboardSetCredentialSubmitEvent prehogv1a.UIOnboardSetCredentialSubmitEvent

UIOnboardSetCredentialSubmitEvent is an UI event sent during registration when the user configures login credentials.

func (*UIOnboardSetCredentialSubmitEvent) Anonymize 

func (u *UIOnboardSetCredentialSubmitEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIRecoveryCodesContinueClickEvent 

type UIRecoveryCodesContinueClickEvent prehogv1a.UIRecoveryCodesContinueClickEvent

UIRecoveryCodesContinueClickEvent is a UI event sent when a user configures recovery codes.

func (*UIRecoveryCodesContinueClickEvent) Anonymize 

func (u *UIRecoveryCodesContinueClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UIRecoveryCodesCopyClickEvent 

type UIRecoveryCodesCopyClickEvent prehogv1a.UIRecoveryCodesCopyClickEvent

UIRecoveryCodesCopyClickEvent is a UI event sent when a user copies recovery codes.

func (*UIRecoveryCodesCopyClickEvent) Anonymize 

func (u *UIRecoveryCodesCopyClickEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UsageReporter 

type UsageReporter interface {
	// AnonymizeAndSubmit submits a usage event. The payload will be
	// anonymized by the reporter implementation.
	AnonymizeAndSubmit(event ...Anonymizable)
}

UsageReporter is a service that accepts Teleport usage events.

type UsageUIRecoveryCodesPrintClick 

type UsageUIRecoveryCodesPrintClick prehogv1a.UIRecoveryCodesPrintClickEvent

UsageUIRecoveryCodesPrintClick is a UI event sent when a user prints recovery codes.

func (*UsageUIRecoveryCodesPrintClick) Anonymize 

func (u *UsageUIRecoveryCodesPrintClick) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UserCertificateIssuedEvent 

type UserCertificateIssuedEvent prehogv1a.UserCertificateIssuedEvent

UserCertificateIssuedEvent is an event emitted when a certificate has been issued, used to track the duration and restriction.

func (*UserCertificateIssuedEvent) Anonymize 

func (u *UserCertificateIssuedEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UserLoginEvent 

type UserLoginEvent prehogv1a.UserLoginEvent

UserLoginEvent is an event emitted when a user logs into Teleport, potentially via SSO.

func (*UserLoginEvent) Anonymize 

func (u *UserLoginEvent) Anonymize(a utils.Anonymizer) prehogv1a.SubmitEventRequest

type UserMetadata 

type UserMetadata struct {
	// Username contains the user's name.
	Username string
	// IsSSO indicates if the user was created by an SSO provider.
	IsSSO bool
}

UserMetadata contains user metadata information which is used to contextualize events with user information.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.