This is the code repository for Ubuntu Insights, a user transparent, open, platform-agnostic and cross application solution for reporting hardware information and other collected metrics.
Ubuntu Insight is designed to show you exactly what is being sent, and allow you to acknowledge and control your own data. The code in this repository is designed to mainly be invoked by a controlling application, but a command-line tool is also provided.
This is designed to be a full replacement for Ubuntu Report.
Ubuntu Insights caches all collected data locally, and will only attempt to upload insights reports following a minimum period (1 week by default). It checks for consent both at the time of collection and at the time of upload. If consent was not given at either of those two points, then the information is not sent to the server. Once a report has been uploaded, it is removed from the local cache folder, and the data that was sent is written to the uploaded folder.
By default, Ubuntu Insights will only collect once per collection period.
To execute the interactive command-line interface manually, use ubuntu-insights.
Consent Files: ~/.config/ubuntu-insights
Reports Cache: ~/.cache/ubuntu-insights
ubuntu-insights [command]
Available Commands:
collect Collect system information
completion Generate the autocompletion script for the specified shell
consent Manage or get user consent state
help Help about any command
upload Upload metrics to the Ubuntu Insights server
Flags:
--config string use a specific configuration file
--consent-dir string the base directory of the consent state files
-h, --help help for ubuntu-insights
--insights-dir string the base directory of the insights report cache
-v, --verbose count issue INFO (-v), DEBUG (-vv)
--version version for ubuntu-insights
Manage or get user consent state for data collection and upload
ubuntu-insights consent [sources](optional arguments) [flags]
Flags:
-h, --help help for consent
-s, --state string the consent state to set (true or false)
Global Flags:
--config string use a specific configuration file
--consent-dir string the base directory of the consent state files
-v, --verbose count issue INFO (-v), DEBUG (-vv)
To get the global consent state using the default consent directory:
foo@bar:~$ ubuntu-insights consent
Global: falseTo set the consent state for the source linux:
foo@bar:~$ ubuntu-insights consent linux -s true
linux: trueCollect system information and metrics and store it locally.
If source is not provided, then the source is assumed to be the currently detected platform. Additionally, there should be no source-metrics-path provided. If source is provided, then the source-metrics-path should be provided as well.
ubuntu-insights collect [source] [source-metrics-path](required if source provided) [flags]
Flags:
-d, --dry-run perform a dry-run where a report is collected, but not written to disk
-f, --force force a collection, override the report if there are any conflicts (doesn't ignore consent)
-h, --help help for collect
-p, --period uint the minimum period between 2 collection periods for validation purposes in seconds (default 1)
Global Flags:
--config string use a specific configuration file
--consent-dir string the base directory of the consent state files
--insights-dir string the base directory of the insights report cache
-v, --verbose count issue INFO (-v), DEBUG (-vv)
Upload metrics to the Ubuntu Insights server.
If no sources are provided, all detected sources at the configured reports directory will be uploaded. If consent is not given for a source, an opt-out notification will be sent regardless of the locally cached insights report's contents.
ubuntu-insights upload [sources](optional arguments) [flags]
Flags:
-d, --dry-run go through the motions of doing an upload, but do not communicate with the server, send the payload, or modify local files
-f, --force force an upload, ignoring min age and clashes between the collected file and a file in the uploaded folder, replacing the clashing uploaded report if it exists (doesn't ignore consent)
-h, --help help for upload
--min-age uint the minimum age (in seconds) of a report before the uploader will attempt to upload it (default 604800)
-r, --retry enable a limited number of retries for failed uploads
Global Flags:
--config string use a specific configuration file
--consent-dir string the base directory of the consent state files
--insights-dir string the base directory of the insights report cache
-v, --verbose count issue INFO (-v), DEBUG (-vv)
{
"insightsVersion": "Dev",
"systemInfo": {
"hardware": {
"product": {
"family": "My Product Family",
"name": "My Product Name",
"vendor": "My Product Vendor"
},
"cpu": {
"name": "9 1200SX",
"vendor": "Authentic",
"architecture": "x86_64",
"cpus": 16,
"sockets": 1,
"coresPerSocket": 8,
"threadsPerCore": 2
},
"gpus": [
{
"device": "0x0294",
"vendor": "0x10df",
"driver": "gpu"
},
{
"device": "0x03ec",
"vendor": "0x1003",
"driver": "gpu"
}
],
"memory": {
"size": 23247
},
"disks": [
{
"size": 1887436,
"type": "disk",
"children": [
{
"size": 750,
"type": "part"
},
{
"size": 260,
"type": "part"
},
{
"size": 16,
"type": "part"
},
{
"size": 1887436,
"type": "part"
},
{
"size": 869,
"type": "part"
},
{
"size": 54988,
"type": "part"
}
]
}
],
"screens": [
{
"size": "600mm x 340mm",
"resolution": "2560x1440",
"refreshRate": "143.83"
},
{
"size": "300mm x 190mm",
"resolution": "1704x1065",
"refreshRate": "119.91"
}
]
},
"software": {
"os": {
"family": "linux",
"distribution": "Ubuntu",
"version": "24.04"
},
"timezone": "EDT",
"language": "en_US",
"bios": {
"vendor": "Bios Vendor",
"version": "Bios Version"
}
},
"platform": {
"desktop": {
"desktopEnvironment": "ubuntu:GNOME",
"sessionName": "ubuntu",
"sessionType": "wayland"
},
"proAttached": true
}
}
}{
"insightsVersion": "Dev",
"systemInfo": {
"hardware": {
"cpu": {
"name": "AM Cirus 1200XK Processor",
"vendor": "Authentic",
"architecture": "x86_64",
"cpus": 256,
"sockets": 1,
"coresPerSocket": 128,
"threadsPerCore": 2
},
"memory": {
"size": 15904
},
"disks": [
{
"size": 388
},
{
"size": 4096
},
{
"size": 1048576
},
{
"size": 1048576
}
]
},
"software": {
"os": {
"family": "linux",
"distribution": "Ubuntu",
"version": "24.04"
},
"timezone": "EDT",
"language": "C"
},
"platform": {
"wsl": {
"subsystemVersion": 2,
"systemd": "used",
"interop": "enabled",
"version": "2.4.11.0",
"kernelVersion": "5.15.167.4-microsoft-standard-WSL2"
},
"proAttached": true
}
}
}{
"OptOut": true
}This is an open source project, and we warmly welcome community contributions, suggestions, and constructive feedback. If you're interested in contributing, please take a look at our Contribution guidelines first.
- To report an issue, please file a bug report against our repository, using a bug template.
- For suggestions and constructive feedback, report a feature request bug report, using the proposed template.
We're friendly! We have a community forum at https://discourse.ubuntu.com where we discuss feature plans, development news, issues, updates and troubleshooting.
For news and updates, follow the Ubuntu Twitter account and on Facebook.