https://github.com/owncloud/diagnostics
:hospital: Collect request data and measure performance
https://github.com/owncloud/diagnostics
owncloud-app
Last synced: 4 months ago
JSON representation
:hospital: Collect request data and measure performance
- Host: GitHub
- URL: https://github.com/owncloud/diagnostics
- Owner: owncloud
- License: agpl-3.0
- Created: 2017-04-06T20:02:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-12-06T00:19:07.000Z (6 months ago)
- Last Synced: 2025-12-09T14:14:52.920Z (6 months ago)
- Topics: owncloud-app
- Language: Starlark
- Homepage:
- Size: 536 KB
- Stars: 4
- Watchers: 44
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ownCloud Diagnostics
:hospital:
[](https://drone.owncloud.com/owncloud/diagnostics)
[](https://sonarcloud.io/dashboard?id=owncloud_diagnostics)
[](https://sonarcloud.io/dashboard?id=owncloud_diagnostics)
[](https://sonarcloud.io/dashboard?id=owncloud_diagnostics)
- [x] Support for 10.0
- [x] Support for 9.1 - [on branch stable9](https://github.com/owncloud/diagnostics/tree/stable9)
- [x] Support for 9.0 - [on branch stable9.1](https://github.com/owncloud/diagnostics/tree/stable9.1)
**Versions for ownCloud 9.0 and 9.1 are limited and only work in debug mode and without user interface. For more features, please update your server version to 10.0**
Enabling this ownCloud diagnostic module will result in collecting data about all queries and events in the system per request.
It will collect information about any type of the request to the server, summarize it and store in the form of log or in any other requested form (export to monitoring).
Module allows to diagnose only selected users after their authentication or enabling collecting data globally for all users with "debug mode".
You can collect data from selected users not affecting performance of the system of other users (data wont be collected and logged).
**By default, none of users is selected - to start logging please select user or allow collecting all data**
# Default log location
Log can be found in the folder `data/diagnostic.log`
# Installation
To install, go to ```/apps``` in your ownCloud installation directory and ```git clone https://github.com/owncloud/diagnostics```. In the apps admin panel enable Diagnostics app.
- To enable app using command line:
`sudo -u www-data php occ app:enable diagnostics`
- To enable [log levels](/lib/Diagnostics.php), e.g. "SUMMARY":
`sudo -u www-data php occ config:app:set --value 1 diagnostics diagnosticLogLevel`
- To enable logging after authentication of specific users using command line:
`sudo -u www-data php occ config:app:set --value "[\"test_shareMountInit\", \"admin\"]" diagnostics diagnosedUsers`
- To enable debug mode globally:
`sudo -u www-data php occ config:system:set --value true debug`
# Usage
Each SUMMARY log if referencing EVENT and QUERY logs via `reqId`.
This allows to build full timeline of the events and corresponding queries for specific type of request e.g. "PROPFIND", only for selected users, as requests are coming.
**Exemplary query log:**
```
{
"type":"QUERY",
"reqId":"JaOvGavLZar0Idhpq5AE",
"diagnostics":{
"sqlStatement":"SELECT s.*, f.`fileid`, f.`path`, st.`id` AS `storage_string_id` FROM `oc_share` s LEFT JOIN `oc_filecache` f ON s.`file_source` = f.`fileid` LEFT JOIN `oc_storages` st ON f.`storage` = st.`numeric_id` WHERE (`share_type` = :dcValue1) AND (`share_with` IN (:dcValue2)) AND ((`item_type` = :dcValue3) OR (`item_type` = :dcValue4)) ORDER BY s.`id` ASC LIMIT 18446744073709551615 OFFSET 0",
"sqlParams":"array ( 'dcValue1' => 1, 'dcValue2' => array ( 'admin' => 'admin', ), 'dcValue3' => 'file', 'dcValue4' => 'folder', )",
"sqlQueryDurationmsec":0.22697448730469,
"sqlTimestamp":1492690459.1778
}
}
```
**Exemplary event log:**
```
{
"type":"EVENT",
"reqId":"JaOvGavLZar0Idhpq5AE",
"diagnostics": {
"eventDescription":"Setup filesystem",
"eventDurationmsec":5.1379203796387,
"eventTimestamp":1492690459.1743
}
}
```
**Exemplary summary log:**
```
{
"type":"SUMMARY",
"reqId":"x0GaTSDAElJ0lKtCj0Wb",
"time":"2017-04-20T12:14:20+00:00",
"remoteAddr":"127.0.0.1",
"user":"admin",
"method":"PROPFIND",
"url":"\/owncloudtest\/remote.php\/webdav\/",
"diagnostics":{
"totalSQLQueries":19,
"totalSQLDurationmsec":2.1142959594727,
"totalSQLParams":45,
"totalEvents":9,
"totalEventsDurationmsec":5.9356689453125
}
}
```