feat(elk-stack-setup): add logging.file.name ci env

[ivor11]

📋 Description

add logging.file.name ci env

JIRA ID:
PSMRI/AMRIT#4

Please provide a summary of the change and the motivation behind it. Include relevant context and details.

---

✅ Type of Change

• 🐞 Bug fix (non-breaking change which resolves an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 🛠 Refactor (change that is neither a fix nor a new feature)
• ⚙️ Config change (configuration file or build script updates)
• 📚 Documentation (updates to docs or readme)
• 🧪 Tests (adding new or updating existing tests)
• 🎨 UI/UX (changes that affect the user interface)
• 🚀 Performance (improves performance)
• 🧹 Chore (miscellaneous changes that don't modify src or test files)

---

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option for logging file name, allowing customization via an environment variable.

• Bug Fixes

  • No significant bug fixes were included in this release.

• Documentation

  • Updated configuration documentation to reflect the new logging property.

[coderabbitai]

Walkthrough

The changes introduce a new configuration entry in the ecd_ci.properties file, specifically for logging purposes. This entry allows the logging file name to be defined via an environment variable, enhancing the flexibility of the logging configuration. The existing database connection configurations and URLs remain unchanged.

Changes

File Path	Change Summary
src/main/environment/ecd_ci.properties	Added new property: logging.file.name=@env.ECD_API_LOGGING_FILE_NAME@

Poem

In the burrow deep, where the data flows,
A new logging path, how it brightly glows!
From the fields of code, a name we can find,
With a hop and a skip, it’s now well-defined.
So let’s log our tales, as the rabbits do play,
In the world of the code, we’ll hop all day! 🐇✨

---

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 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/main/environment/ecd_ci.properties (2)

20-20: Consider adding a default value for local development

While the environment variable substitution works well for CI, it might be helpful to provide a default value for local development environments.

Consider using this pattern:

-logging.file.name=@env.ECD_API_LOGGING_FILE_NAME@
+logging.file.name=@env.ECD_API_LOGGING_FILE_NAME:logs/ecd-api.log@

---

19-19: Enhance the configuration comment

The current comment could be more descriptive to explain the purpose and expected value of this configuration.

Consider updating the comment to:

-#ELK logging file name
+# ELK Stack logging file name - Specifies the path where application logs will be written

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d9fe6b2 and d8637ee.

📒 Files selected for processing (1)

• src/main/environment/ecd_ci.properties (1 hunks)

🔇 Additional comments (1)

src/main/environment/ecd_ci.properties (1)

18-20: LGTM! The logging configuration follows the established patterns.

The addition of the logging file name configuration is well-structured:

• Follows the existing property file format
• Uses appropriate section comment
• Consistent with the @env.VARIABLE_NAME@ pattern used throughout the file

Let's verify the environment variable usage in the CI configuration: