Add docs for Connect usage reporting by gzdunek · Pull Request #21294 · gravitational/teleport

gzdunek · 2023-02-06T14:52:42Z

Backport to v12 when we enable it in Connect (and add a link in the dialog to the docs).

gzdunek · 2023-02-06T14:53:46Z

+- Starting an SSH, database, or kube session
+- File transfer during an SSH session
+- Managing access requests
+- Asking about job role


@ravicious I added "asking about job role" too. Although it is a slightly different type of event (it is not collected in the background, but rather asked explicitly) I think it makes sense to have it on the list.

alexfornuto

Approved, but should not be merged (or at least not backported) yet per the comment below.

ptgott · 2023-02-06T23:14:47Z

@@ -0,0 +1,18 @@
+When you first start the app, Teleport Connect asks for permission to collect & send telemetry data.
+This includes tracking events such as:
+- Login


Suggested change

- Login

- Logging in to Teleport

Assuming this is correct (making it more specific)

Maybe Logging in to a cluster?

Works for me!

ptgott · 2023-02-06T23:15:40Z

+- Login
+- Starting an SSH, database, or kube session
+- File transfer during an SSH session
+- Managing access requests


Does this include creating an Access Request as well as other events in the Access Request lifecycle?

It includes two events: creating and reviewing an Access Request.

👍 I think it would make sense to list both of these separately

Three events actually, assuming an access request is reported as well.

Good catch, I forgot about it.

ptgott · 2023-02-06T23:16:31Z

+- Starting an SSH, database, or kube session
+- File transfer during an SSH session
+- Managing access requests
+- Asking about job role


Is there another way to put this? This is the only instance of "job role" in the docs, and it would be good to be more consistent with other pages:

$ grep -Rni "job role" docs/pages docs/pages/includes/teleport-connect-telemetry.mdx:7:- Asking about job role

Any suggestions?
We ask users about it to get a list of job roles for people who are using Teleport Connect. Nothing better than "job role" comes to my mind 😏

Ah, that make sense. I wasn't sure what context to use for interpreting "job role". Maybe something like, "Indicating when Teleport Connect asks a user to describe their role at their organization"?

Are all the items in this list events that Teleport Connect tracks? If the job title item isn't, I think we should separate it from this list.

Ah, I realized that including "job role" it the list is confusing, because the event is not intended to indicate that the user was asked, we collect the user's response itself.
What do you think of adding a line below - Processor architecture:

Additionally, we ask for a job role (answer is optional).

That sounds good to me!

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

gzdunek · 2023-02-07T18:58:34Z

@ptgott I pushed all the changes, please take a look at the final version 🙏

ravicious · 2023-02-08T14:22:17Z

+
+### Disabling telemetry
+
+If you initially agreed to share telemetry data, but now want to opt out, you need to update the `app_config.json` file:


Does the app need to be closed first? I don't remember if we dump the current config to the file just like we do with app_state.json.

No, it doesn't. The config file is updated only on change.

ravicious · 2023-02-08T14:23:13Z

I suppose the backport to v12 should wait until we actually track that data in v12, right?

gzdunek · 2023-02-08T16:40:26Z

I suppose the backport to v12 should wait until we actually track that data in v12, right?

Yes.

public-teleport-github-review-bot · 2023-02-08T17:54:18Z

@gzdunek See the table below for backport results.

Branch	Result
branch/v12	Create PR

* Add docs for Connect usage reporting * reuse telemetry specifics in partial file * copy edits * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Add Zac's suggestion Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com> * Apply suggestions * Add "Assuming an Access Request" --------- Co-authored-by: alexfornuto <alex.fornuto@goteleport.com> Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

Add docs for Connect usage reporting

bfb8002

gzdunek added the backport/branch/v12 label Feb 6, 2023

gzdunek requested review from klizhentas and ravicious February 6, 2023 14:52

github-actions Bot added documentation size/sm labels Feb 6, 2023

github-actions Bot requested review from alexfornuto, ptgott, r0mant, xinding33 and zmb3 February 6, 2023 14:53

gzdunek commented Feb 6, 2023

View reviewed changes

reuse telemetry specifics in partial file

8cea3fd

alexfornuto self-assigned this Feb 6, 2023

copy edits

daa8966

alexfornuto approved these changes Feb 6, 2023

View reviewed changes

Comment thread docs/pages/includes/teleport-connect-telemetry.mdx Outdated

alexfornuto removed their assignment Feb 6, 2023

ptgott reviewed Feb 6, 2023

View reviewed changes

Apply suggestions from code review

1ebe7fe

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

zmb3 approved these changes Feb 7, 2023

View reviewed changes

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated

gzdunek and others added 3 commits February 7, 2023 19:53

Add Zac's suggestion

d67d7e9

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

Apply suggestions

f2757a1

Merge branch 'master' into gzdunek/connect-usage-reporting-docs

a37a840

ptgott approved these changes Feb 7, 2023

View reviewed changes

public-teleport-github-review-bot Bot removed request for klizhentas, r0mant, ravicious and xinding33 February 7, 2023 22:24

ravicious approved these changes Feb 8, 2023

View reviewed changes

gzdunek added 2 commits February 8, 2023 17:38

Add "Assuming an Access Request"

6db1891

Merge branch 'master' into gzdunek/connect-usage-reporting-docs

797bb10

gzdunek added this pull request to the merge queue Feb 8, 2023

Merged via the queue into master with commit e8de43e Feb 8, 2023

gzdunek mentioned this pull request Mar 6, 2023

[v12] Add docs for Connect usage reporting #22661

Merged

gzdunek deleted the gzdunek/connect-usage-reporting-docs branch March 20, 2023 16:29


		### Disabling telemetry

		If you initially agreed to share telemetry data, but now want to opt out, you need to update the `app_config.json` file:

Conversation

gzdunek commented Feb 6, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexfornuto left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gzdunek commented Feb 7, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ravicious commented Feb 8, 2023

Uh oh!

gzdunek commented Feb 8, 2023

Uh oh!

public-teleport-github-review-bot Bot commented Feb 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

alexfornuto left a comment •

edited

Loading