Add telemetry to Todo #101

larkox · 2020-07-22T10:17:51Z

Summary

Add telemetry to Todo. The content of the todos is not registered.

Goals:

Collect information about user activity so we can prioritize improvements in the Todo plugin
Have an understanding of how many users interact with Todo once or multiple times and how many users as a percentage of the total number of seats at the Mattermost deployment use Todo Plugin.

Track:

Every command performed (even errors)
Every todo added
Every todo sent
Every todo completed
Every todo accepted
Every todo removed
Every todo bumped
Every click on the channel header button
Every click on the post action
Every click on the collapse-expand button of the lists
Every click on the custom post buttons
Every click on the "create new todo" button on the RHS
Every click on the buttons on the LHS

Ticket Link

None

codecov-commenter · 2020-08-05T11:41:39Z

Codecov Report

Merging #101 into master will decrease coverage by 0.25%.
The diff coverage is 0.00%.

@@            Coverage Diff            @@
##           master    #101      +/-   ##
=========================================
- Coverage    3.81%   3.55%   -0.26%     
=========================================
  Files           9      10       +1     
  Lines         971    1042      +71     
=========================================
  Hits           37      37              
- Misses        933    1004      +71     
  Partials        1       1

Impacted Files	Coverage Δ
server/command.go	`11.29% <0.00%> (-0.20%)`	⬇️
server/configuration.go	`0.00% <0.00%> (ø)`
server/plugin.go	`0.00% <0.00%> (ø)`
server/telemetry.go	`0.00% <0.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2a69b7...b34b25d. Read the comment docs.

aaronrothschild

LGTM.

aaronrothschild · 2020-08-28T16:12:56Z

We should update the Telemetry docs to indicate what is tracked for this plugin.

hanzei

LGTM. A few questions bellow, but nothing blocking.

hanzei · 2020-08-31T15:36:58Z

server/plugin.go

+	Properties map[string]interface{}
+}
+
+func (p *Plugin) handleTelemetry(w http.ResponseWriter, r *http.Request) {


IIRC, in the core product the client does the requests the telemetry platform itself. Is is something we should adopt for plugins?

If not, can we move this code into the library as well?

My point is not sharing the key to the clients (my own concern, probably not a real concern) and to keep one single "source of truth" (the server). Also, it helps to keep some privacy for the clients, since other information (that might be useful or not) like carrier or so that probably is automatically fetched by rudder will not be fetched.

0/5 on whether or how this should be added to the library. We could add the whole handling like we are doing for the settings panel, or we can just add the handleTelemetry function and leave the routing to the plugin.

Personally, I like it with the server doing the reporting and one less moving part for people to track and more consistent across plugins.

Good points @larkox 👍

Exporting handleTelemetry seams like a good first step until we figured out, what other things we need in the library.

hanzei · 2020-08-31T15:37:27Z

server/plugin.go

@@ -219,6 +271,7 @@ func (p *Plugin) handleList(w http.ResponseWriter, r *http.Request) {
 		lt := time.Unix(lastReminderAt/1000, 0).In(timezone)
 		if nt.Sub(lt).Hours() >= 1 && (nt.Day() != lt.Day() || nt.Month() != lt.Month() || nt.Year() != lt.Year()) {
 			p.PostBotDM(userID, "Daily Reminder:\n\n"+issuesListToString(issues))
+			p.trackDailySummary(userID)


What is the value we get from tracking this event?

Understanding how many daily summaries are being sent. May allow us to see errors in the code (more than one daily summary per user), or see how active are the users of the plugin.

I think it makes sense to add this because we now have the user setting to disable the reminders.

server/telemetry.go

mickmister

LGTM 👍

DHaussermann

Tested and passed

Tested that all events get logged
- trackSendIssue
- trackAddIssue
- trackAcceptIssue
- trackBumpIssue
- trackCommand
- trackCompleteIssue
- trackRemoveIssue
- trackFrontend (todo_frontend_rhs_add)
Data seems accurate
Ensured that plugin works normally when EnableDiagnostic is set to false with no crashes
LGTM!

Add telemetry to Todo

e4b8a65

larkox added 1: PM Review Requires review by a product manager Awaiting Submitter Action Blocked on the author labels Jul 22, 2020

larkox requested a review from aaronrothschild July 22, 2020 10:17

larkox self-assigned this Jul 22, 2020

larkox added 2 commits August 4, 2020 12:30

Fix bugs with telemetry

a454b75

Merge branch 'master' into AddTelemetry

dc763fd

larkox removed the Awaiting Submitter Action Blocked on the author label Aug 4, 2020

larkox added 2 commits August 5, 2020 13:31

Fix lint

914501a

Go mod tidy

4d03a08

larkox mentioned this pull request Aug 10, 2020

Jira V3 merge candidate mattermost/mattermost-plugin-jira#610

Merged

jfrerich mentioned this pull request Aug 13, 2020

[GH-612] Add ability to change telemetry key to production key on release builds mattermost/mattermost-plugin-jira#623

Merged

larkox added 3 commits August 20, 2020 14:07

Close telemetry client on deactivate

690e269

Merge branch 'master' into AddTelemetry

31d7cf5

Fix typo

e4f13b7

aaronrothschild approved these changes Aug 28, 2020

View reviewed changes

larkox requested review from mickmister and hanzei August 28, 2020 16:36

larkox added 2: Dev Review Requires review by a core committer and removed 1: PM Review Requires review by a product manager labels Aug 28, 2020

hanzei approved these changes Aug 31, 2020

View reviewed changes

Type telemetry source

71dcc26

mickmister approved these changes Sep 2, 2020

View reviewed changes

mickmister added 3: QA Review Requires review by a QA tester and removed 2: Dev Review Requires review by a core committer labels Sep 2, 2020

mickmister requested a review from DHaussermann September 2, 2020 15:34

Merge branch 'master' into AddTelemetry

b34b25d

DHaussermann approved these changes Sep 2, 2020

View reviewed changes

DHaussermann added 4: Reviews Complete All reviewers have approved the pull request and removed 3: QA Review Requires review by a QA tester labels Sep 2, 2020

hanzei added this to the v0.4.0 milestone Sep 3, 2020

larkox merged commit bfa5742 into mattermost-community:master Sep 7, 2020

larkox mentioned this pull request Sep 7, 2020

Bump version to 0.4.0 #117

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add telemetry to Todo #101

Add telemetry to Todo #101

larkox commented Jul 22, 2020 •

edited by aaronrothschild

Loading

codecov-commenter commented Aug 5, 2020 •

edited

Loading

aaronrothschild left a comment

aaronrothschild commented Aug 28, 2020

hanzei left a comment

hanzei Aug 31, 2020

larkox Sep 2, 2020

aaronrothschild Sep 2, 2020

hanzei Sep 3, 2020 •

edited

Loading

hanzei Aug 31, 2020

larkox Sep 2, 2020

mickmister Sep 4, 2020

mickmister left a comment

DHaussermann left a comment •

edited

Loading

Add telemetry to Todo #101

Add telemetry to Todo #101

Conversation

larkox commented Jul 22, 2020 • edited by aaronrothschild Loading

Summary

Ticket Link

codecov-commenter commented Aug 5, 2020 • edited Loading

Codecov Report

aaronrothschild left a comment

Choose a reason for hiding this comment

aaronrothschild commented Aug 28, 2020

hanzei left a comment

Choose a reason for hiding this comment

hanzei Aug 31, 2020

Choose a reason for hiding this comment

larkox Sep 2, 2020

Choose a reason for hiding this comment

aaronrothschild Sep 2, 2020

Choose a reason for hiding this comment

hanzei Sep 3, 2020 • edited Loading

Choose a reason for hiding this comment

hanzei Aug 31, 2020

Choose a reason for hiding this comment

larkox Sep 2, 2020

Choose a reason for hiding this comment

mickmister Sep 4, 2020

Choose a reason for hiding this comment

mickmister left a comment

Choose a reason for hiding this comment

DHaussermann left a comment • edited Loading

Choose a reason for hiding this comment

larkox commented Jul 22, 2020 •

edited by aaronrothschild

Loading

codecov-commenter commented Aug 5, 2020 •

edited

Loading

hanzei Sep 3, 2020 •

edited

Loading

DHaussermann left a comment •

edited

Loading