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.

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

Implement logging #38

Closed
lawrence-forooghian opened this issue Sep 3, 2024 · 0 comments · Fixed by #39
Closed

Implement logging #38

lawrence-forooghian opened this issue Sep 3, 2024 · 0 comments · Fixed by #39
Assignees
Labels
enhancement New feature or improved functionality.

Comments

@lawrence-forooghian
Copy link
Collaborator

lawrence-forooghian commented Sep 3, 2024

The library is not yet emitting any log statements.

  • add a default logger that uses Logger or something else sensible
  • pass it around the codebase
  • add log statements to the code written for Chat room skeleton #19

┆Issue is synchronized with this Jira Story by Unito

@lawrence-forooghian lawrence-forooghian added the enhancement New feature or improved functionality. label Sep 3, 2024
@lawrence-forooghian lawrence-forooghian self-assigned this Sep 3, 2024
lawrence-forooghian added a commit that referenced this issue Sep 5, 2024
The aim of this commit is to:

- provide infrastructure for internal components to be able to log
  messages
- add some log messages to the existing functionality (I am not
  particularly concerned by the quality or utility of these log messages
  at the moment)
- provide a basic default logging backend so that users can see log
  messages in the console

The choice to have a separate internal logging interface is taken from
Asset Tracking and ably-cocoa, where I think it works well. I haven’t
currently copied across Asset Tracking’s subsystem mechanism, a large
part of the motivation for which was to provide a way to integrate the
logs emitted by the AAT-instantiated Realtime client into those emitted
by AAT itself; this is not currently a goal for Chat, which does not
instantiate a Realtime client.

I briefly toyed with the idea of writing a macro that would log the
inputs and outputs of public API methods, but figuring out how to do
that didn’t seem like a good use of time now.

Resolves #38.
lawrence-forooghian added a commit that referenced this issue Sep 5, 2024
The aim of this commit is to:

- provide infrastructure for internal components to be able to log
  messages
- add some log messages to the existing functionality (I am not
  particularly concerned by the quality or utility of these log messages
  at the moment)
- provide a basic default logging backend so that users can see log
  messages in the console

The choice to have a separate internal logging interface is taken from
Asset Tracking (AAT) and ably-cocoa, where I think it works well. I
haven’t currently copied across AAT’s subsystem mechanism, a large part
of the motivation for which was to provide a way to integrate the logs
emitted by the AAT-instantiated Realtime client into those emitted by
AAT itself; this is not currently a goal for Chat, which does not
instantiate a Realtime client.

I briefly toyed with the idea of writing a macro that would log the
inputs and outputs of public API methods, but figuring out how to do
that didn’t seem like a good use of time now.

Resolves #38.
lawrence-forooghian added a commit that referenced this issue Sep 5, 2024
The aim of this commit is to:

- provide infrastructure for internal components to be able to log
  messages
- add some log messages to the existing functionality (I am not
  particularly concerned by the quality or utility of these log messages
  at the moment)
- provide a basic default logging backend so that users can see log
  messages in the console

The choice to have a separate internal logging interface is taken from
Asset Tracking (AAT) and ably-cocoa, where I think it works well. I
haven’t currently copied across AAT’s subsystem mechanism, a large part
of the motivation for which was to provide a way to integrate the logs
emitted by the AAT-instantiated Realtime client into those emitted by
AAT itself; this is not currently a goal for Chat, which does not
instantiate a Realtime client.

I briefly toyed with the idea of writing a macro that would log the
inputs and outputs of public API methods, but figuring out how to do
that didn’t seem like a good use of time now.

Resolves #38.
lawrence-forooghian added a commit that referenced this issue Sep 5, 2024
The aim of this commit is to:

- provide infrastructure for internal components to be able to log
  messages
- add some log messages to the existing functionality (I am not
  particularly concerned by the quality or utility of these log messages
  at the moment)
- provide a basic default logging backend so that users can see log
  messages in the console

The choice to have a separate internal logging interface is taken from
Asset Tracking (AAT) and ably-cocoa, where I think it works well. I
haven’t currently copied across AAT’s subsystem mechanism, a large part
of the motivation for which was to provide a way to integrate the logs
emitted by the AAT-instantiated Realtime client into those emitted by
AAT itself; this is not currently a goal for Chat, which does not
instantiate a Realtime client.

I briefly toyed with the idea of writing a macro that would log the
inputs and outputs of public API methods, but figuring out how to do
that didn’t seem like a good use of time now.

Resolves #38.
lawrence-forooghian added a commit that referenced this issue Sep 6, 2024
The aim of this commit is to:

- provide infrastructure for internal components to be able to log
  messages
- add some log messages to the existing functionality (I am not
  particularly concerned by the quality or utility of these log messages
  at the moment)
- provide a basic default logging backend so that users can see log
  messages in the console

The choice to have a separate internal logging interface is taken from
Asset Tracking (AAT) and ably-cocoa, where I think it works well. I
haven’t currently copied across AAT’s subsystem mechanism, a large part
of the motivation for which was to provide a way to integrate the logs
emitted by the AAT-instantiated Realtime client into those emitted by
AAT itself; this is not currently a goal for Chat, which does not
instantiate a Realtime client.

I briefly toyed with the idea of writing a macro that would log the
inputs and outputs of public API methods, but figuring out how to do
that didn’t seem like a good use of time now.

Resolves #38.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improved functionality.
Development

Successfully merging a pull request may close this issue.

1 participant