Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Define SDK’s public logging API #1628

Open
lawrence-forooghian opened this issue Apr 6, 2023 · 1 comment
Open

Define SDK’s public logging API #1628

lawrence-forooghian opened this issue Apr 6, 2023 · 1 comment
Labels
enhancement New feature or improved functionality.
Milestone
Logging

Comments

@lawrence-forooghian
Copy link
Collaborator

lawrence-forooghian commented Apr 6, 2023 •
edited by sync-by-unito bot
Loading

Background

The issues #1618 and #1625 will define the requirements for an (SDK user-provided) object that receives log output from the SDK and is responsible for writing it to some sort of output.

This issue aims to define the API of this object as an Objective-C protocol.

Next steps

In #1620 we’ll create the protocol which will implement this interface. Initially its interface will be similar to that of ARTLog. In #1621, we’ll create an adapter implementation of this protocol, which writes its output to a given ARTLog instance.

After that, as the requirements of #1618 and #1625 become clearer, we’ll split this task into tasks that update the protocol to satisfy these requirements.

#1631 suggests writing mini-libraries that attempt to integrate this interface with some commonly-used logging libraries. This will help us validate that this interface is fit for purpose.

┆Issue is synchronized with this Jira Task by Unito
@lawrence-forooghian lawrence-forooghian added this to the Logging milestone Apr 6, 2023
@sync-by-unito
Copy link

sync-by-unito bot commented Apr 6, 2023

➤ Automation for Jira commented:

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

This was referenced Apr 6, 2023
Closed
Open
Open
Closed
Open
lawrence-forooghian added a commit that referenced this issue Apr 10, 2023
@lawrence-forooghian
Stop using the logWithError: method
514177a 
It’s only being used in one place internally. I don’t think it makes
sense to log an error message without describing the context in which
the error occurred. We’ll revisit whether there’s something this should
be replaced by, as part of #1617 and #1628.
lawrence-forooghian added a commit that referenced this issue Apr 10, 2023
@lawrence-forooghian
Stop using the logWithError: method
425dd50 
It’s only being used in one place internally. Furthermore, I don’t think
it makes sense to log an error message without describing the context in
which the error occurred. We’ll revisit whether there’s something more
appropriate this should be replaced by, as part of #1617 and #1628.
@lawrence-forooghian lawrence-forooghian mentioned this issue Apr 10, 2023
Merged
lawrence-forooghian added a commit that referenced this issue Apr 10, 2023
@lawrence-forooghian
Stop using the logWithError: method
32baa84 
It’s only being used in one place internally. Furthermore, I don’t think
it makes sense to log an error message without describing the context in
which the error occurred. We’ll revisit whether there’s something more
appropriate this should be replaced by, as part of #1617 and #1628.
@umair-ably umair-ably added the enhancement New feature or improved functionality. label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or improved functionality.
Milestone
Logging
Development

No branches or pull requests
2 participants
@lawrence-forooghian @umair-ably