feat: make slogger logging optional

[Harish-osmosys]

API PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed unit testing for the new feature added or updated to ensure the new features added are working as expected.
• I have added/updated test cases to the test suite as applicable.
• I have performed preliminary testing using the test suite to ensure that any existing features are not impacted and any new features are working as expected as a whole.
• I have added/updated the required api docs as applicable.
• I have added/updated the .env.example file with the required values as applicable.

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite/unit testing output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.

---

Description:

Add a optional flag for slogger logging based on the env variable set log is sent to slogger , by default it set as false

Related changes:

• Update env.example file

Screenshots:

N/A

Query request and response:

N/A

Documentation changes:

N/A

Test suite/unit testing output:

N/A

Pending actions:

N/A

Additional notes:

N/A

Summary by CodeRabbit

• Configuration
  • Added a new environment configuration option ENABLE_SLOGERR to control Slogger error reporting
  • Implemented conditional logging transport based on the new configuration setting

[coderabbitai]

Walkthrough

This pull request introduces a new configuration variable ENABLE_SLOGERR to control the Slogger error reporting feature. The change involves adding the environment variable to the .env.example file and modifying the logger configuration to conditionally include the SlogerrTransport based on the new setting. When set to 'true', the Slogger transport will be enabled; otherwise, it remains disabled by default.

Changes

File	Change Summary
apps/api/.env.example	Added new configuration variable ENABLE_SLOGERR=false
apps/api/src/config/logger.config.ts	Introduced enableSlogger constant to conditionally include SlogerrTransport

Possibly related PRs

• feat: integrate slogger with current logging #376: Introduces configuration parameters for Slogger and integrates SlogerrTransport class into logging setup

Suggested labels

ready for review

Suggested reviewers

• xixas

Poem

🐰 A logger's tale of config delight,
Where Slogger waits, hidden from sight
With ENABLE_SLOGERR as the key
To unlock errors, set it free!
A rabbit's whisper of control so bright 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/api/src/config/logger.config.ts (1)

21-22: Consider normalizing environment variable checks.

Currently, the code directly checks for the string 'true'. If the environment variable has different casing (e.g., 'TRUE') or whitespace, this conditional might fail. Consider using .toLowerCase().trim() === 'true' for a more robust check:

- const enableSlogger = configService.get<string>('ENABLE_SLOGERR') || 'false';
+ const enableSloggerRaw = configService.get<string>('ENABLE_SLOGERR') || 'false';
+ const enableSlogger = enableSloggerRaw.toLowerCase().trim() === 'true';

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 319d361 and ba83bcd.

📒 Files selected for processing (2)

• apps/api/.env.example (1 hunks)
• apps/api/src/config/logger.config.ts (2 hunks)

🔇 Additional comments (2)

apps/api/src/config/logger.config.ts (1)

100-100: Good use of optional transport inclusion.

Conditionally enabling the slogerrTransport based on an environment variable is a clean approach, keeping the default behavior disabled while providing an easy toggle.

apps/api/.env.example (1)

25-25: Environment variable is well-documented and consistent with code.

The ENABLE_SLOGERR variable defaulting to false matches the implementation, ensuring that Slogerr logging remains off by default unless explicitly enabled.