Understand how to help users capture logs to help us diagnose issues

[lawrence-forooghian]

Background

As described in #1623, one of the uses of the information logged by the SDK is to help Ably SDK developers debug unexpected behaviours being experienced by users of the SDK.

We need to define a process for guiding our users in collecting this data if necessary, and for giving ourselves confidence that the gathered data will help us debug the issue.

Requirements

We need to meet the following requirements:

• if we need users to collect logs for us, we should tell them what logs we need — and we should be confident that this information will enable us to debug the issue
  • this includes what level they should be logging at (see Define the different log levels and how they should be used #1634 for defining what these levels mean)
  • we should think through scenarios that users may wish us to debug, and what information we’d need to debug them
  • we should think through the implications of collecting this data — for example, if users are collecting the data in the wild on their users’ devices, we might need to be able to give users an idea of the storage overhead this might imply
• we should enable users to provide us with as little sensitive data as necessary (see redaction in Understand SDK users’ requirements for log output #1618)

┆Issue is synchronized with this Jira Task by Unito

[sync-by-unito]

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3518