feat: Standardize log patterns across all services for consistency. #38285
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis pull request standardizes and enhances logging configurations across multiple Supervisord configuration files for various services in the Appsmith deployment. The changes include updating log file paths to incorporate the hostname, increasing log file sizes from 10MB to 30MB, removing log file backups, and adding event logging capabilities. These modifications aim to improve log management and traceability across different application components. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (6)
🚧 Files skipped from review as they are similar to previous changes (6)
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
Documentation and Community
|
subhrashisdas
force-pushed
the
feature-uniform-logs
branch
2 times, most recently
from
d70b34d to
c94f52f
Compare
subhrashisdas
changed the title
subhrashisdas
force-pushed
the
feature-uniform-logs
branch
from
c94f52f to
1d56a86
Compare
subhrashisdas
added
skip-changelog
subhrashisdas
requested review from
sharat87 and
pratapaprasanna
as code owners
subhrashisdas
added
skip-changelog
github-actions
bot
added
Enhancement
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (4)
deploy/docker/fs/opt/appsmith/templates/supervisord/postgres.conf (2)
12-13: Reconsider log size limits for database serviceThe 30MB log size limit might be insufficient for a database service, which typically generates more logs than application services.
Consider:
- Increasing
*_logfile_maxbytesfor database services- Implementing log rotation based on time rather than size
- Setting up database-specific logging configurations
Also applies to: 15-16
9-16: Consider implementing a comprehensive logging strategyWhile standardizing log patterns is good, consider implementing:
- Centralized log aggregation (e.g., ELK stack, Splunk)
- Service-specific log retention policies
- Structured logging format for better searchability
- Monitoring and alerts for log storage usage
Would you like assistance in designing a comprehensive logging architecture?
deploy/docker/fs/opt/appsmith/templates/supervisord/mongodb.conf (1)
3-3: Review MongoDB logging strategyMongoDB is configured with both native logging (
--logpath) and supervisord logging. This could lead to:
- Duplicate logs consuming extra disk space
- Confusion when debugging issues
Consider using only MongoDB's native logging mechanism and monitoring it through supervisord.Also applies to: 11-17
deploy/docker/fs/opt/appsmith/templates/supervisord/redis.conf (1)
14-15: Implement a log retention strategy for Redis logsWhile directing Redis logs to stdout is correct, consider:
- Implementing log rotation with a reasonable number of backups
- Setting up external log aggregation for persistent storage
This ensures no critical information is lost during debugging or auditing.Also applies to: 18-19
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/backend.conf(1 hunks)deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/editor.conf(1 hunks)deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/rts.conf(1 hunks)deploy/docker/fs/opt/appsmith/templates/supervisord/mongodb.conf(1 hunks)deploy/docker/fs/opt/appsmith/templates/supervisord/postgres.conf(1 hunks)deploy/docker/fs/opt/appsmith/templates/supervisord/redis.conf(1 hunks)
deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/editor.conf
Show resolved
Hide resolved
deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/backend.conf
Outdated
Show resolved
Hide resolved
deploy/docker/fs/opt/appsmith/templates/supervisord/application_process/rts.conf
Show resolved
Hide resolved
subhrashisdas
force-pushed
the
feature-uniform-logs
branch
from
1d56a86 to
1c48cae
Compare
|
/build-deploy-preview |
|
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12463126378. |
|
Deploy-Preview-URL: https://ce-38285.dp.appsmith.com |
subhrashisdas
requested review from
nidhi-nair,
rajatagrawal and
ApekshaBhosale
sagar-qa007
added
ok-to-test
sharat87
approved these changes
Dec 23, 2024
NandanAnantharamu
pushed a commit
that referenced
this pull request
Dec 27, 2024
…38285) ## Description > [!TIP] > _Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team)._ > > _Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR._ Fixes #`Issue Number` _or_ Fixes `Issue URL` > [!WARNING] > _If no issue exists, please create an issue first, and check with the maintainers if the issue is valid._ ## Automation /ok-to-test tags="@tag.Sanity" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/12463955629> > Commit: 1c48cae > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12463955629&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity` > Spec: > <hr>Mon, 23 Dec 2024 09:18:41 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced logging capabilities for various services, including distinct log file paths incorporating hostnames. - Introduced event logging for standard output and error streams. - **Bug Fixes** - Improved error handling through updated logging configurations. - **Chores** - Reorganized configuration parameters for better clarity and management across multiple services. - Increased maximum log file sizes from 10MB to 30MB and set backups to zero for all services. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Tip
Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).
Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.
Fixes #
Issue Numberor
Fixes
Issue URLWarning
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.
Automation
/ok-to-test tags="@tag.Sanity"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12463955629
Commit: 1c48cae
Cypress dashboard.
Tags:
@tag.SanitySpec:
Mon, 23 Dec 2024 09:18:41 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
New Features
Bug Fixes
Chores