Update README.md to specify gathered telemetry by JamesWTruher · Pull Request #16379 · PowerShell/PowerShell

JamesWTruher · 2021-11-05T16:16:55Z

PR Summary

The telemetry statement in the README seems out of date.

PR Context

The telemetry statement should fully describe the data we gather.

PR Checklist

SteveL-MSFT · 2021-11-05T16:20:29Z

Isn't it more accurate that if it's anything other than 1,yes, or true then it defaults to false meaning to send telemetry?

SteveL-MSFT · 2021-11-05T16:21:23Z

it would be great to make these links to the source code where we collect this information

Make sure to use the permanent links to files.

@SteveL-MSFT - this could be problematic if the code changes

SteveL-MSFT · 2021-11-05T16:21:50Z

make that a link instead of text to the source line

Make sure to use the permanent links to files.

StevenBucher98 · 2021-11-05T17:55:49Z

Suggested change

- The name of a module when loaded if it is in the pre-approved list of modules (see line 128 in src/System.Management.Automation/utils/Telemetry.cs).

- The name of a module when loaded if it is in the pre-approved [list of modules](https://github.com/PowerShell/PowerShell/blob/d74c6bfb7bc2ff84ae15cceeba2fb7dc5c3ccd17/src/System.Management.Automation/utils/Telemetry.cs#L128)

If it is not best practice to include this line number perma-link then feel free to ignore.

daxian-dbw · 2021-11-05T17:56:19Z

Does the guid representing the session get generated for every session? or are those 2 using the same guid?

daxian-dbw · 2021-11-05T17:56:43Z

Suggested change

- The value of the environment variable `POWERSHELL_DISTRIBUTION_CHANNEL`

- The value of the environment variable `POWERSHELL_DISTRIBUTION_CHANNEL`, if available

daxian-dbw · 2021-11-05T18:01:08Z

Just out of curiosity, how useful do we think it is to collect the command type information?

@JamesWTruher can you please comment on this question? I'm just curious how useful this information turns out to be in our telemetry analysis so far.

daxian-dbw · 2021-11-05T18:53:46Z

Pointing to the topic doc is surely better.

daxian-dbw · 2021-11-05T21:33:58Z

@JamesWTruher please fix up the spelling issue, which caused the 'static-analysis' CI failed.

daxian-dbw

'static-analysis' CI failed, need to fix the spelling issue.

Co-authored-by: Steve Lee <slee@microsoft.com>

pull-request-quantifier-deprecated · 2021-11-10T00:51:23Z

This PR has 12 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Small
Size       : +9 -3
Percentile : 4.8%

Total files changed: 5

Change summary by file extension:
.spelling : +1 -0
.yml : +6 -0
.md : +2 -3

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detetcted.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

TravisEz13 · 2021-11-10T00:56:33Z

I updated the CI yamls so future PRs to readme and spelling shouldn't trigger product tests, but because the PR now touches those files, we need to run those pipelines to validate those changes.

sdwheeler

Changes look good to me.

ghost · 2021-12-16T19:59:54Z

🎉v7.3.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

ghost assigned daxian-dbw Nov 5, 2021

pull-request-quantifier-deprecated Bot added the Extra Small label Nov 5, 2021

JamesWTruher requested review from SteveL-MSFT, StevenBucher98 and sdwheeler November 5, 2021 16:17

SteveL-MSFT reviewed Nov 5, 2021

View reviewed changes

Comment thread README.md Outdated

SteveL-MSFT reviewed Nov 5, 2021

View reviewed changes

Comment thread README.md Outdated

StevenBucher98 reviewed Nov 5, 2021

View reviewed changes

daxian-dbw reviewed Nov 5, 2021

View reviewed changes

SteveL-MSFT approved these changes Nov 5, 2021

View reviewed changes

sdwheeler approved these changes Nov 5, 2021

View reviewed changes

StevenBucher98 approved these changes Nov 5, 2021

View reviewed changes

daxian-dbw requested changes Nov 5, 2021

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 5, 2021

JamesWTruher and others added 5 commits November 9, 2021 15:30

updates to telemetry section of readme

ba33921

fine tune telemetry language.

056af51

Update README.md

3bb28e1

Co-authored-by: Steve Lee <slee@microsoft.com>

Update README.md

3480717

Co-authored-by: Steve Lee <slee@microsoft.com>

Just point to the about_Telemetry topic.

aaddade

JamesWTruher force-pushed the ReadMeTelemetryUpdate01 branch from b8c6be1 to aaddade Compare November 9, 2021 23:30

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 9, 2021

JamesWTruher and others added 2 commits November 9, 2021 15:35

Add 'about_Telemetry' to the spell check file.

6fc6108

Update linux.yml

3c7b892

TravisEz13 requested review from adityapatwardhan and anmenaga as code owners November 10, 2021 00:50

TravisEz13 requested review from PaulHigin and TravisEz13 as code owners November 10, 2021 00:50

TravisEz13 added 2 commits November 9, 2021 16:50

Update mac.yml

3c57880

Update windows.yml

12abbd4

sdwheeler approved these changes Nov 10, 2021

View reviewed changes

daxian-dbw approved these changes Nov 10, 2021

View reviewed changes

daxian-dbw merged commit 19b5647 into PowerShell:master Nov 10, 2021

TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Nov 11, 2021

Update README.md to specify gathered telemetry (PowerShell#16379)

2d30699

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022

Update README.md to specify gathered telemetry (PowerShell#16379)

2ffef44

	- The name of a module when loaded if it is in the pre-approved list of modules (see line 128 in src/System.Management.Automation/utils/Telemetry.cs).
	- The name of a module when loaded if it is in the pre-approved [list of modules](https://github.com/PowerShell/PowerShell/blob/d74c6bfb7bc2ff84ae15cceeba2fb7dc5c3ccd17/src/System.Management.Automation/utils/Telemetry.cs#L128)

	- The value of the environment variable `POWERSHELL_DISTRIBUTION_CHANNEL`
	- The value of the environment variable `POWERSHELL_DISTRIBUTION_CHANNEL`, if available

Conversation

JamesWTruher commented Nov 5, 2021

PR Summary

PR Context

PR Checklist

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!

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!

daxian-dbw commented Nov 5, 2021

Uh oh!

daxian-dbw commented Nov 5, 2021

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

pull-request-quantifier-deprecated Bot commented Nov 10, 2021

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

TravisEz13 commented Nov 10, 2021

Uh oh!

sdwheeler left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Dec 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants