chore: caddy: enable logging of static file requests

[dvj1988]

Description

• Enable logs of static file requests in caddy.
• Skip logging for CSS and JS source map files. These files are inconsequential for page rendering and therefore not worth tracking, as they only pollute the log files.

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

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11016033178
Commit: 97cfe30
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Wed, 25 Sep 2024 05:08:51 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Enhanced logging configurations to improve performance by skipping logs for health check requests and JavaScript map files.

• Bug Fixes

  • Adjusted existing logging behavior for file handling to ensure more accurate log processing.

[coderabbitai]

Warning

Rate limit exceeded

@dvj1988 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 21 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Commits

Files that changed from the base of the PR and between 17b44bc and 97cfe30.

Walkthrough

The changes in this pull request focus on enhancing the logging configurations within the caddy-reconfigure.mjs file. Specifically, it introduces mechanisms to skip logging for health check requests and JavaScript map files. The modifications include the creation of a named matcher for map files and adjustments to existing logging directives, which may alter how logs are processed for file requests.

Changes

File Path	Change Summary
deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs	Added logging configurations to skip logs for health check requests and JavaScript map files. Modified existing logging behavior for file handling.

Possibly related PRs

• chore: Add cache control header for static files #35461: The changes in this PR also modify the caddy-reconfigure.mjs file, focusing on HTTP header configurations, which may relate to the logging configurations introduced in the main PR.

Suggested reviewers

• sharat87
• rajatagrawal
• pratapaprasanna

Poem

In the logs where silence reigns,
Health checks and maps escape the chains.
With clever rules, we weave a way,
To keep the noise and clutter at bay.
A dance of data, neat and bright,
Logging’s now a pure delight! 🌟

---

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.

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.

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11008499766.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36500.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-36500.dp.appsmith.com

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11015472051.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36500.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-36500.dp.appsmith.com

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11015602294.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36500.
recreate: .

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (1)

79-84: Excellent work on organizing our log skipping, students!

Your addition of a named matcher for JavaScript map files is like creating a special folder for your homework - it keeps things neat and tidy. This will help reduce noise in our logs and focus on more important entries.

However, let's make sure everyone in the class understands what we're doing here. How about we add a brief comment explaining why we're skipping these logs?

Consider adding a comment like this above the @MapFiles block:

# Skip logging for JavaScript source map files to reduce log volume

This will help your fellow students (I mean, developers) understand the purpose of this configuration at a glance.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4a70072 and ff32ad9.

Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (1 hunks)

Additional comments not posted (2)

deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (2)

75-76: Well done, class! This change is a gold star addition.

Skipping logs for health check requests is a smart move. It's like separating the wheat from the chaff in our log files. This will help keep our logs focused on the important stuff and prevent them from getting cluttered with routine health checks.

---

84-84: Hold on a minute, class! Let's discuss this change.

I noticed you've removed the 'skip_log' directive from the '@file' handler. This is like suddenly deciding to record every single conversation in the classroom - it could lead to a lot of chatter!

Can you explain to the class why you've made this change? We need to consider:

1. How will this affect our log volume?
2. Are we prepared to handle the increased storage needs?
3. What valuable information do we expect to gain from logging all file requests?

Let's do a quick check to see how this might impact our system. Run this command to count the number of file requests we typically see:

This will give us an idea of how many additional log entries we might be adding each day.

[github-actions]

Deploy-Preview-URL: https://ce-36500.dp.appsmith.com

[dvj1988]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11016039654.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36500.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-36500.dp.appsmith.com