Skip to content

[MM-51269] Log errors from telemetry events #653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hanzei merged 2 commits into from
Mar 23, 2023
Merged

[MM-51269] Log errors from telemetry events #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b988cd7
Log errors from telemetry events
hanzei Mar 9, 2023
9f1a3e2
Also log errors from user events
hanzei Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions server/plugin/flows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
pluginapi "github.com/mattermost/mattermost-plugin-api"
"github.com/mattermost/mattermost-plugin-api/experimental/flow"

"github.com/mattermost/mattermost-plugin-api/experimental/telemetry"
"github.com/pkg/errors"

"github.com/mattermost/mattermost-server/v6/model"
Expand All @@ -23,6 +22,11 @@ type PingBroker interface {
SubscribePings() <-chan *github.PingEvent
}

type Tracker interface {
TrackEvent(event string, properties map[string]interface{})
TrackUserEvent(event, userID string, properties map[string]interface{})
}

type FlowManager struct {
client *pluginapi.Client
pluginURL string
Expand All @@ -32,7 +36,7 @@ type FlowManager struct {
getGitHubClient func(ctx context.Context, userID string) (*github.Client, error)

pingBroker PingBroker
tracker telemetry.Tracker
tracker Tracker

setupFlow *flow.Flow
oauthFlow *flow.Flow
Expand All @@ -50,7 +54,7 @@ func (p *Plugin) NewFlowManager() *FlowManager {
getGitHubClient: p.GetGitHubClient,

pingBroker: p.webhookBroker,
tracker: p.tracker,
tracker: p,
}

fm.setupFlow = fm.newFlow("setup").WithSteps(
Expand Down Expand Up @@ -223,14 +227,14 @@ func (fm *FlowManager) StartSetupWizard(userID string, delegatedFrom string) err
}

func (fm *FlowManager) trackStartSetupWizard(userID string, fromInvite bool) {
_ = fm.tracker.TrackUserEvent("setup_wizard_start", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("setup_wizard_start", userID, map[string]interface{}{
"from_invite": fromInvite,
"time": model.GetMillis(),
})
}

func (fm *FlowManager) trackCompleteSetupWizard(userID string) {
_ = fm.tracker.TrackUserEvent("setup_wizard_complete", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("setup_wizard_complete", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}
Expand All @@ -249,13 +253,13 @@ func (fm *FlowManager) StartOauthWizard(userID string) error {
}

func (fm *FlowManager) trackStartOauthWizard(userID string) {
_ = fm.tracker.TrackUserEvent("oauth_wizard_start", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("oauth_wizard_start", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}

func (fm *FlowManager) trackCompleteOauthWizard(userID string) {
_ = fm.tracker.TrackUserEvent("oauth_wizard_complete", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("oauth_wizard_complete", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}
Expand Down Expand Up @@ -591,13 +595,13 @@ func (fm *FlowManager) StartWebhookWizard(userID string) error {
}

func (fm *FlowManager) trackStartWebhookWizard(userID string) {
_ = fm.tracker.TrackUserEvent("webhook_wizard_start", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("webhook_wizard_start", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}

func (fm *FlowManager) trackCompleteWebhookWizard(userID string) {
_ = fm.tracker.TrackUserEvent("webhook_wizard_complete", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("webhook_wizard_complete", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}
Expand Down Expand Up @@ -755,13 +759,13 @@ func (fm *FlowManager) StartAnnouncementWizard(userID string) error {
}

func (fm *FlowManager) trackStartAnnouncementWizard(userID string) {
_ = fm.tracker.TrackUserEvent("announcement_wizard_start", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("announcement_wizard_start", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}

func (fm *FlowManager) trackCompletAnnouncementWizard(userID string) {
_ = fm.tracker.TrackUserEvent("announcement_wizard_complete", userID, map[string]interface{}{
fm.tracker.TrackUserEvent("announcement_wizard_complete", userID, map[string]interface{}{
"time": model.GetMillis(),
})
}
Expand Down
16 changes: 15 additions & 1 deletion server/plugin/telemetry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ const (
keysPerPage = 1000
)

func (p *Plugin) TrackEvent(event string, properties map[string]interface{}) {
err := p.tracker.TrackEvent(event, properties)
if err != nil {
p.API.LogDebug("Error sending telemetry event", "event", event, "error", err.Error())
}
}

func (p *Plugin) TrackUserEvent(event, userID string, properties map[string]interface{}) {
err := p.tracker.TrackUserEvent(event, userID, properties)
if err != nil {
p.API.LogDebug("Error sending user telemetry event", "event", event, "error", err.Error())
}
}

func (p *Plugin) SendDailyTelemetry() {
config := p.getConfiguration()

Expand All @@ -19,7 +33,7 @@ func (p *Plugin) SendDailyTelemetry() {
p.API.LogWarn("Failed to get the number of connected users for telemetry", "error", err)
}

_ = p.tracker.TrackEvent("stats", map[string]interface{}{
p.TrackEvent("stats", map[string]interface{}{
"connected_user_count": connectedUserCount,
"is_oauth_configured": config.IsOAuthConfigured(),
"is_sass": config.IsSASS(),
Expand Down