{"id":13582443,"url":"https://github.com/ubuntu/ubuntu-report","last_synced_at":"2026-03-16T07:03:06.223Z","repository":{"id":47108954,"uuid":"124517762","full_name":"ubuntu/ubuntu-report","owner":"ubuntu","description":"Report hardware and other collected metrics like installer or upgrade information","archived":false,"fork":false,"pushed_at":"2024-11-26T15:22:23.000Z","size":1315,"stargazers_count":70,"open_issues_count":26,"forks_count":31,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-30T03:06:16.346Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubuntu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-09T09:20:20.000Z","updated_at":"2025-01-04T06:07:39.000Z","dependencies_parsed_at":"2024-01-19T08:17:09.403Z","dependency_job_id":"fbc29736-4ad4-4e46-b562-3caf60bf3635","html_url":"https://github.com/ubuntu/ubuntu-report","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubuntu%2Fubuntu-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubuntu%2Fubuntu-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubuntu%2Fubuntu-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubuntu%2Fubuntu-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubuntu","download_url":"https://codeload.github.com/ubuntu/ubuntu-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430872,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:02:43.068Z","updated_at":"2026-03-16T07:03:06.214Z","avatar_url":"https://github.com/ubuntu.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Ubuntu Report\nReport hardware and other collected metrics like installer or upgrade information.\n\nCheck [Ubuntu Insights](https://github.com/ubuntu/ubuntu-insights) as the new telemetry tool for ubuntu.\n\nThis information can't be used to identify a single machine and is presented before being sent to the server.\n\n[![Build \u0026 Tests Status](https://travis-ci.org/ubuntu/ubuntu-report.svg?branch=master)](https://travis-ci.org/ubuntu/ubuntu-report)\n[![codecov](https://codecov.io/gh/ubuntu/ubuntu-report/branch/master/graph/badge.svg)](https://codecov.io/gh/ubuntu/ubuntu-report)\n[![Go Report Card](https://goreportcard.com/badge/github.com/ubuntu/ubuntu-report)](https://goreportcard.com/report/github.com/ubuntu/ubuntu-report)\n\nAPIS:\n * Go: [![Go API](https://godoc.org/github.com/ubuntu/ubuntu-report?status.svg)](https://godoc.org/github.com/ubuntu/ubuntu-report/pkg/sysmetrics)\n * C: [![C API](https://godoc.org/github.com/ubuntu/ubuntu-report?status.svg)](https://godoc.org/github.com/ubuntu/ubuntu-report/pkg/sysmetrics/C)\n\n\n## About\n\nThe tool will show you what is going to be reported and ask for your acknowledgement before uploading it. It will be mainly\ninvoked by a GUI, but it provides also a command line tool.\n\nThe Ubuntu welcome UI has a dedicated panel for this report collection and upload.\n\nThe command line tool as well as the Go and C API have different modes:\n* Interactive mode (prompt displaying the data being sent and ask if sending or opting out)\n* Only show the report\n* Report automatically the collected data without prompting\n* Report that you have opted out of data collection\n\nBy default, you can only report your data collection once per distribution version.\n\nTo execute the interactive command line interface manually, just use `ubuntu-report`.\n\n## Command line usage\n\n### ubuntu-report\n\nReport metrics from your system, install and upgrades\n\n#### Synopsis\n\nThis tool will collect and report metrics from current hardware, partition and session information.\nThis information can't be used to identify a single machine and is presented before being sent to the server.\n\n```\nubuntu-report [flags]\n```\n\n#### Options\n\n```\n  -f, --force           collect and send new report even if already reported\n  -h, --help            help for ubuntu-report\n  -u, --url string      server url to send report to. Leave empty for default. (default \"https://metrics.ubuntu.com\")\n  -v, --verbose count   issue INFO (-v) and DEBUG (-vv) output\n```\n\n### ubuntu-report interactive\n\nInteractive mode, alias to running this tool without any subcommands.\n\n### ubuntu-report send\n\nSend or opt-out directly from metric reports without interactions\n\n#### Synopsis\n\nSend or opt-out directly from metric reports without interactions\n\n```\nubuntu-report send yes|no [flags]\n```\n\n#### Options\n\n```\n  -h, --help         help for send\n  -u, --url string   server url to send report to. Leave empty for default. (default \"https://metrics.ubuntu.com\")\n```\n\n#### Options inherited from parent commands\n\n```\n  -f, --force           collect and send new report even if already reported\n  -v, --verbose count   issue INFO (-v) and DEBUG (-vv) output\n```\n\n### ubuntu-report service\n\nTry to send periodically previously unsent but collected data once network is avaiable\n\n#### Synopsis\n\nTry to send periodically previously unsent but collected data once network is avaiable\n\n```\nubuntu-report service [flags]\n```\n\n#### Options\n\n```\n  -h, --help         help for service\n  -u, --url string   server url to send report to. Leave empty for default. (default \"https://metrics.ubuntu.com\")\n```\n\n#### Options inherited from parent commands\n\n```\n  -f, --force           collect and send new report even if already reported\n  -v, --verbose count   issue INFO (-v) and DEBUG (-vv) output\n```\n\n### ubuntu-report show\n\nOnly collect and display metrics without sending\n\n#### Synopsis\n\nOnly collect and display metrics without sending\n\n```\nubuntu-report show [flags]\n```\n\n#### Options\n\n```\n  -h, --help   help for show\n```\n\n#### Options inherited from parent commands\n\n```\n  -f, --force           collect and send new report even if already reported\n  -v, --verbose count   issue INFO (-v) and DEBUG (-vv) output\n```\n\n## Service\n\nIn case we can't report (due to limited network or other networking conditions) your report when you act on it,\na little service will kick at login, and try to send the pending report data again. Note that it will exponentially\nback off.\n\nThe service won't be active once the pending report is sent.\n\n## APIS\n\n### Go API\n\nThe Go API is used by the command line, but can be embedded as well by 3rd parties. Doc reference is available at\n[![this link](https://godoc.org/github.com/ubuntu/ubuntu-report?status.svg)](https://godoc.org/github.com/ubuntu/ubuntu-report/pkg/sysmetrics).\n\n### C API\n\nThe C API is provided for embedding the library in C code. Doc reference is available at\n[![this link](https://godoc.org/github.com/ubuntu/ubuntu-report?status.svg)](https://godoc.org/github.com/ubuntu/ubuntu-report/pkg/sysmetrics/C).\n\nYou can generate the shared library and headers by running `go generate`.\n\n## Command line options\n\nYou can regenerate previous README section, shell completion support and man pages by simply running `go generate`.\n\n## Send data to server\n\n### Example of data being sent if agreement is accepted\n\nThe data are pretty printed here to be more readable.\n\n```json\n{\n  \"Version\": \"18.04\",\n  \"OEM\": {\n    \"Vendor\": \"Vendor Name\",\n    \"Product\": \"4287CTO\"\n  },\n  \"BIOS\": {\n    \"Vendor\": \"Vendor Name\",\n    \"Version\": \"8DET52WW (1.27)\"\n  },\n  \"CPU\": {\n    \"OpMode\": \"32-bit, 64-bit\",\n    \"CPUs\": \"8\",\n    \"Threads\": \"2\",\n    \"Cores\": \"4\",\n    \"Sockets\": \"1\",\n    \"Vendor\": \"Genuine\",\n    \"Family\": \"6\",\n    \"Model\": \"158\",\n    \"Stepping\": \"10\",\n    \"Name\": \"Intius Corus i5-8300H CPU @ 2.30GHz\",\n    \"Virtualization\": \"VT-x\"\n  },\n  \"Arch\": \"amd64\",\n  \"GPU\": [\n    {\n      \"Vendor\": \"8086\",\n      \"Model\": \"0126\"\n    }\n  ],\n  \"RAM\": 8,\n  \"Disks\": [\n    240.1,\n    500.1\n  ],\n  \"Partitions\": [\n    229.2,\n    479.7\n  ],\n  \"Screens\": [\n    {\n      \"Size\": \"277mmx156mm\",\n      \"Resolution\": \"1366x768\",\n      \"Frequency\": \"60.02\"\n    },\n    {\n      \"Resolution\": \"1920x1080\",\n      \"Frequency\": \"60.00\"\n    }\n  ],\n  \"Autologin\": false,\n  \"LivePatch\": true,\n  \"Session\": {\n    \"DE\": \"ubuntu:GNOME\",\n    \"Name\": \"ubuntu\",\n    \"Type\": \"x11\"\n  },\n  \"Language\": \"fr_FR\",\n  \"Timezone\": \"Europe/Paris\",\n  \"Install\": {\n    \"Media\": \"Ubuntu 18.04 LTS \\\"Bionic Beaver\\\" - Alpha amd64 (20180305)\",\n    \"Type\": \"GTK\",\n    \"PartitionMethod\": \"use_device\",\n    \"DownloadUpdates\": true,\n    \"Language\": \"fr\",\n    \"Minimal\": false,\n    \"RestrictedAddons\": false,\n    \"Stages\": {\n      \"0\": \"language\",\n      \"3\": \"language\",\n      \"10\": \"console_setup\",\n      \"15\": \"prepare\",\n      \"25\": \"partman\",\n      \"27\": \"start_install\",\n      \"37\": \"timezone\",\n      \"49\": \"usersetup\",\n      \"57\": \"user_done\",\n      \"829\": \"done\"\n    }\n  }\n}\n```\n\n### Data being sent if agreement is denied\n\nThe data are pretty printed here to be more readable.\n\n```json\n{\n  \"OptOut\": true\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubuntu%2Fubuntu-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubuntu%2Fubuntu-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubuntu%2Fubuntu-report/lists"}