nextcloud / nextcloud/talk-android
improve logging & reporting
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 739
- Forks
- 321
- Avg merge
- 14h 59m
- Merged PRs (30d)
- 151
Description
The log handling of the talk app needs to be improved.
current situation
-
the Log util from android itself is used but there is no chance to get these logs from a user who wants to report a bug.
-
the class "LoggingUtils" exists which obviously had the goal to have another logging with the possibility get the logs as a log file. (But unfortunately this flooded the logfile which led to bug reports like https://github.com/nextcloud/talk-android/issues/1013).
So the class can be considered experimental.
requirements
- there needs to be one solution for logging.
- this might require to wrap the log commands from the android logging util?
- all logs should be written to a file
- use some file rolling strategy
- the user should be able to send the log file to nextcloud by mail (might require some research regarding file permissions)
- before sending:
- it might be useful to collect some information from the used nextcloud instance (server version, talk version, ..?) and append this to the log?
- there must be the possibility to for him to scroll through the file and check if he has privacy concerns.
- He has to confirm that all data from the file can be seen by nextcloud employees.
- before sending:
- the user experience for sending log files should be the same as for the files app (to be discussed with @tobiasKaminsky )
- as a first important usecase for improved logging it makes sense to concentrate on notifications
the logging solution from the files app might give some inspirations:
https://github.com/nextcloud/android-library/blob/master/src/main/java/com/owncloud/android/lib/common/utils/Log_OC.java
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing LoggingUtils class, Android's Log utility, and the linked Log_OC.java implementation for the files app. Define the notification-focused logging flow, including file rolling, user review and consent, and sending logs to Nextcloud; completion requires one unified solution covering these requirements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, kotlin
- Domain
- mobile, observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100