Understand Ably SDK developers’ requirements for log output

[lawrence-forooghian]

Background

1623 describes the situations in which Ably SDK developers might wish to read the log messages emitted by the SDK. For a developer to be able to read these messages, the SDK first needs to write them to some sort of output.

1618 describes a general set of requirements for this output. In the current issue, we shall describe additional requirements that are particularly relevant for Ably SDK developers.

Thoughts

• It should be able to write output in a machine-parseable form, so that we can run analysis on the logs (i.e. easy to separate log message body from metadata, including in multi-line message case)
• Making ably-cocoa seem like an integrated part of our own SDKs, so that these SDKs can present their log output consistently (e.g. integrating into the subsystem hierarchy in AAT) — this is pretty much already described in #1618, though (user embedding ably-cocoa in a library)

Next steps

Put this in front of other Ably SDK developers for thoughts and to gather further requirements.

┆Issue is synchronized with this Jira Task by Unito

[sync-by-unito[bot]]

➤ Automation for Jira commented:

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