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

feat: enhanced logger module #657

Merged
merged 4 commits into from
Sep 23, 2022
Merged

feat: enhanced logger module #657

merged 4 commits into from
Sep 23, 2022

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Sep 20, 2022

Description of the change

Added a new logger module and implemented it for Amplitude destination.
A few advantages:

  • The logger instance is unique to the module that it is used. We can set scope which will be automatically prefixed to the messages. For destinations, it can be the name of the destination.
  • Eliminates the need to manually prefix the messages with destination or module names.
  • Adds a default prefix "RS SDK".
  • The message prefixes help the developers to easily identify and filter the messages of the SDK/scope on the browser console.

The plan is to slowly extend this for the rest of the SDK going forward.

Example output:
image

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Related issues

N/A

Checklists

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
  • "Ready for review" label attached to the PR and reviewers mentioned in a comment
  • Changes have been reviewed by at least one other engineer
  • Issue from task tracker has a link to this pull request

This change is Reviewable

@saikumarrs saikumarrs self-assigned this Sep 20, 2022
utils/logger.js Outdated Show resolved Hide resolved
@saikumarrs saikumarrs merged commit abe450c into v1-staging Sep 23, 2022
@saikumarrs saikumarrs deleted the logger-refactor branch September 23, 2022 09:57
@mihir-4116 mihir-4116 mentioned this pull request Nov 28, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants