feat(elk-stack-setup): add logging.file.name ci env #63
Conversation
WalkthroughThe pull request introduces a new configuration entry in the Changes
Possibly related PRs
Suggested reviewers
Poem
Warning Rate limit exceeded@ivor11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 43 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
src/main/environment/admin_ci.properties (1)
20-21: Consider adding complementary logging propertiesWhile the logging file name is set, consider adding these additional properties for better ELK integration:
#ELK logging file name logging.file.name=@env.ADMIN_API_LOGGING_FILE_NAME@ +#ELK logging pattern and rotation +logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n +logging.file.max-size=10MB +logging.file.max-history=30These additions would:
- Ensure consistent log formatting for better parsing in ELK
- Implement log rotation to manage disk space
- Maintain a reasonable history of log files
| #ELK logging file name | ||
| logging.file.name=@env.ADMIN_API_LOGGING_FILE_NAME@ |
There was a problem hiding this comment.
💡 Codebase verification
Environment variable needs documentation and conflicts with default configuration
- The
ADMIN_API_LOGGING_FILE_NAMEenvironment variable is not documented in any README or .env files - There's a conflict with
logging.file.namebeing set in both:src/main/environment/admin_ci.properties(environment variable)src/main/resources/application.properties(hardcoded value)
Please:
- Document the
ADMIN_API_LOGGING_FILE_NAMEenvironment variable in appropriate documentation - Remove or comment out the hardcoded
logging.file.nameinapplication.propertiesto avoid configuration conflicts
🔗 Analysis chain
LGTM! Verify environment variable setup in CI
The addition of logging.file.name property is correct and follows Spring Boot's standard logging configuration. This is essential for ELK stack integration.
Let's verify the environment variable setup:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for environment variable documentation and usage
# Check if the environment variable is documented in README or similar files
echo "Checking for environment variable documentation..."
rg -i "ADMIN_API_LOGGING_FILE_NAME" -g "README*" -g "*.md" -g "*.env*"
# Check for other logging-related configurations that might need to be consistent
echo "Checking for related logging configurations..."
rg "logging\." -g "*.properties" -g "*.yml"
Length of output: 947
2 participants
📋 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
ℹ️ 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
These changes enhance the application's logging capabilities without affecting existing configurations.