Skip to main content

Telemetry

General info​

CLI for Microsoft 365 uses telemetry by default to track the usage within the project. Besides usage statistics, this gives us information to better understand how the CLI for Microsoft 365 is being used and where we can make improvements.

It is important to note that we never track personal information in our telemetry. For example, we track which command you are using and which command options, but the information passed to these options is never included in the telemetry.

To provide an overview, this is what we track when a command is executed:

  • Name of the executed command
  • Usage of command options (only usage, not data provided with the options)
  • CLI for Microsoft 365 version
  • Node.js version of your environment
  • The type of shell you are using (PowerShell, Zsh, Cmd, Azure Cloud Shell, ...)
  • Whether you are using a Docker container
  • Whether you are using a CI/CD setup

Example​

An example is worth more than a thousand words. The following example illustrates which telemetry is being collected when executing a command.

Pretend we have CLI for Microsoft 365 version 6.0.0 installed within a Node.js v16.13.2 environment. Next, we open a PowerShell window and execute the following command.

m365 spo file add --webUrl "https://contoso.sharepoint.com/sites/project-x" --folder "/sites/project-x/Shared Documents" --path "C:\MS365.jpg" --contentType "Picture" --publish --publishComment "Lorem ipsum"

Executing this command will result in the following telemetry being collected:

DescriptionTelemetry data
Command namespo file add
Command options1contentType: true
checkOut: false
checkInComment: false
approve: false
approveComment: false
publish: true
publishComment: true
query: false
output: json
verbose: false
debug: false
CLI for M365 version6.0.0
Node.js versionv16.13.2
Shellpwsh.exe
Docker container
CI/CD setupfalse

Disable telemetry​

note

We offer the option to disable all telemetry within the project. However, we encourage you to leave it enabled as it helps us to understand the usage and impact of our work.

Run the following command to disable the telemetry.

m365 cli config set --key disableTelemetry --value true

Re-enable telemetry​

Run the following command to re-enable the telemetry.

m365 cli config reset --key disableTelemetry

Footnotes​

  1. Note that we are only tracking the usage of optional options. Required options are always filled in and therefore there is no added value for us to include them in the telemetry. ↩

CTRL + M