https://github.com/nextcloud/user_usage_report

👱📈 User usage report
https://github.com/nextcloud/user_usage_report

Last synced: 2 months ago
JSON representation

👱📈 User usage report

• Host: GitHub
• URL: https://github.com/nextcloud/user_usage_report
• Owner: nextcloud
• License: agpl-3.0
• Created: 2017-09-11T14:10:22.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-26T20:08:01.000Z (7 months ago)
• Last Synced: 2024-05-28T00:11:37.760Z (7 months ago)
• Language: PHP
• Homepage: https://apps.nextcloud.com/apps/user_usage_report
• Size: 729 KB
• Stars: 40
• Watchers: 5
• Forks: 11
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/contributing.md
  • License: COPYING
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-starred - nextcloud/user_usage_report - 👱📈 User usage report (others)

README

        
# User usage report

To generate the report for a user, run the following command:

```sh

$ sudo -u www-data ./occ usage-report:generate admin

"admin","2017-09-18T09:00:01+00:00",5368709120,786432000,12,1,1,2

```

Leaving out the user argument will generate a report for all users on the system:

```sh

$ sudo -u www-data ./occ usage-report:generate --display-name

"admin","Nextcloud Admin","2017-09-18T09:00:01+00:00",5368709120,786432000,12,1,1,2

"test1","Test User 1","2017-09-18T09:00:01+00:00",-2,954368,6,0,2,10

"test2","Second Test user","2017-09-18T09:00:01+00:00",-2,164,4,0,0,0

"test3","Test User Three","2017-09-18T09:00:01+00:00",-2,164,4,0,0,0

"test5","Fifth Tester","2017-09-18T09:00:01+00:00",-2,164,4,0,0,0

```

The CSV data is the following:

* User identifier

* User display name (when `--display-name` is given)

* Current date and time (default in ISO 8601 format, but any format can be specified)

* Last login date and time (default in ISO 8601 format, but any format can be specified)  (when `--last-login` is given)

* Assigned home storage size in bytes (`-3` is unlimited, `-2` is unknown/not set)

* Disk space consumed by home storage in bytes (`-2` is unknown)

* Number of files in home storage

* Number of shares created

* Number of files created (new files only)

* Number of files read (download/view)

To include the header of the fields in the CSV use the `--verbose` option:

```sh

$ sudo -u www-data ./occ usage-report:generate --verbose admin

"user-id","date as 'c'","assigned quota (5 GB)","used quota (500 MB)",number of files,number of shares,number of uploads,number of downloads

"admin","2017-09-18T09:00:01+00:00",5368709120,786432000,12,1,1,2

```