]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-17193 Documentation about Telemetry (#6577)
authorPeeter Piegaze <61758048+peeter-piegaze-sonarsource@users.noreply.github.com>
Thu, 1 Sep 2022 13:34:49 +0000 (15:34 +0200)
committersonartech <sonartech@sonarsource.com>
Mon, 5 Sep 2022 20:02:56 +0000 (20:02 +0000)
server/sonar-docs/src/pages/instance-administration/telemetry.md [new file with mode: 0644]
server/sonar-docs/src/pages/setup/sonar-properties.md
server/sonar-docs/static/SonarQubeNavigationTree.json
server/sonar-docs/static/StaticNavigationTree.json
sonar-application/src/main/assembly/conf/sonar.properties

diff --git a/server/sonar-docs/src/pages/instance-administration/telemetry.md b/server/sonar-docs/src/pages/instance-administration/telemetry.md
new file mode 100644 (file)
index 0000000..f2bda56
--- /dev/null
@@ -0,0 +1,119 @@
+---
+title: Telemetry
+url: /instance-administration/telemetry/
+---
+
+SonarQube periodically sends telemetry data to SonarSource.
+This data helps us understand how SonarQube is used, which helps us improve our products.
+
+
+## No personally identifiable information is sent
+
+The telemetry doesn't collect personal data, such as usernames or email addresses.
+It doesn't send source code or data such as project name, repository, or author.
+No IP addresses are sent.
+The data is sent securely, held under restricted access, and not published outside of SonarSource.
+
+Protecting your privacy is important to us.
+If you suspect the telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, please send an email to `security@sonarsource.com` so that we can investigate.
+
+
+## Turning it off
+
+You can disable telemetry at any time by setting the `sonar.telemetry.enabled` property to `false` in `$SONARQUBE-HOME/conf/sonar.properties`.
+By default, it is set to `true`.
+
+
+## What information is sent?
+
+Once a day (every 24 hours), SonarQube sends a `JSON` payload to `https://telemetry.sonarsource.com/sonarqube`.
+
+The data that is sent includes:
+
+* Information about the SonarQube instances itself (version, edition, database type, etc.)
+* The list of projects on the instance including, for each:
+  * A traceable unique project identifier (but one which doesn’t reveal any identifying information about the project)
+  * Information about the project like language, last analysis time, number of lines of code, etc.
+* The list of users on that instance including, for each:
+  * A traceable unique user identifier (but one which doesn’t reveal any identifiying information about the user)
+  * Information about the user's usage of the system like time of last login and current status.
+
+Here is an example of a telemetry payload:
+
+```
+{
+  "id": "ID",
+  "version": "9.6",
+  "edition": "enterprise",
+  "licenseType": "TEST-LICENCE",
+  "database": {
+    "name": "oracle",
+    "version": "2.0.0"
+  },
+  "plugins": [
+    {
+      "name": "plugin-name",
+      "version": "9.6"
+    }
+  ],
+  "externalAuthProviders": [
+    "sonarqube"
+  ],
+  "installationDate": 1661933380862,
+  "installationVersion": "9.6",
+  "docker": false,
+  "users": [
+    {
+      "userUuid": "UUID-1",
+      "status": "active",
+      "lastActivity": "2022-01-01T08:00:00+00"
+    }
+  ],
+  "projects": [
+    {
+      "projectUuid": "UUID-1",
+      "lastAnalysis": "2022-01-01T08:00:00+00"
+      "language": "java",
+      "loc": 40
+    },
+    {
+      "projectUuid": "UUID-2",
+      "lastAnalysis": "2022-01-01T08:00:00+00"
+      "language": "ts",
+      "loc": 24
+    },
+    {
+      "projectUuid": "UUID-3",
+      "lastAnalysis": "2022-08-31T10:09:56+0200",
+      "language": "css",
+      "loc": 7
+    }
+  ],
+  "projects-general-stats": [
+    {
+      "projectUuid": "UUID-1",
+      "branchCount": 2,
+      "pullRequestCount": 0,
+      "scm": "undetected",
+      "ci": "cirrus_ci",
+      "alm": "gitlab_cloud"
+    },
+    {
+      "projectUuid":"UUID-2",
+      "branchCount": 1,
+      "pullRequestCount": 0,
+      "scm": "undetected",
+      "ci": "undetected",
+      "alm": "github_cloud"
+    },
+    {
+      "projectUuid": "UUID-3",
+      "branchCount": 1,
+      "pullRequestCount": 0,
+      "scm": "undetected",
+      "ci": "undetected",
+      "alm": "undetected"
+    }
+  ]
+}
+```
index addbb7b691ece2638501d37708c52fa1a0357104..f39a8a48963f4e93cff38612f28d1ad828545d1c 100644 (file)
@@ -406,7 +406,7 @@ Delay in seconds between processing of notification queue. Default is 60 seconds
 Paths to persistent data files (embedded database and search index) and temporary files. Can be absolute or relative to installation directory. Defaults are respectively <installation home>/data and <installation home>/temp
 
 **`SONAR_TELEMETRY_ENABLE=true`**
-Telemetry - Share anonymous SonarQube statistics. By sharing anonymous SonarQube statistics, you help us understand how SonarQube is used so we can improve the product to work even better for you. We don't collect source code or IP addresses. And we don't share the data with anyone else. To see an example of the data shared: login as a global administrator, call the WS api/system/info and check the Statistics field.
+Telemetry - Share anonymous SonarQube statistics. By sharing anonymous SonarQube statistics, you help us understand how SonarQube is used so we can improve the product to work even better for you. We don't collect source code or IP addresses. And we don't share the data with anyone else. For more information, see [Telemetry](/instance-administration/telemetry/).
 
 ## Development – only for developers
 [[warning]]
index 76288e1397bfd69e52030eaff104bb21ecfa0db1..0e47a473fbb84a6a942833bcefb1db370de587f9 100644 (file)
       "/instance-administration/project-move/",
       "/instance-administration/compute-engine-performance/",
       "/instance-administration/db-copy/",
-      "/instance-administration/backup-restore/"
+      "/instance-administration/backup-restore/",
+      "/instance-administration/telemetry/"
     ]
   },
   {
index f6d985aa6213e49473c6183f3d910ce972fdc2bb..d6ca2db257796895c52cba4817707bbcc3e95a60 100644 (file)
       "/instance-administration/project-move/",
       "/instance-administration/compute-engine-performance/",
       "/instance-administration/db-copy/",
-      "/instance-administration/backup-restore/"
+      "/instance-administration/backup-restore/",
+      "/instance-administration/telemetry/"
     ]
   },
   {
index fc3c22b91efadb81bf057409376cf8ece2ccda86..245602296827d26a3ef3efe1bb55c47260847027 100644 (file)
 # Telemetry - Share anonymous SonarQube statistics
 # By sharing anonymous SonarQube statistics, you help us understand how SonarQube is used so we can improve the product to work even better for you.
 # We don't collect source code or IP addresses. And we don't share the data with anyone else.
-# To see an example of the data shared: login as a global administrator, call the WS api/system/info and check the Statistics field.
 #sonar.telemetry.enable=true