Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

ivor11
Copy link
Contributor

@ivor11 ivor11 commented Dec 2, 2024

πŸ“‹ Description

add logging.file.name ci env

JIRA ID:
PSMRI/AMRIT#4


βœ… 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

    • Enhanced logging configuration for the FHIR API by specifying a dedicated logging file.
  • Bug Fixes

    • No bug fixes included in this release.
  • Documentation

    • No documentation updates included in this release.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes involve the addition of a new configuration entry in the common_ci.properties file located in the src/main/environment directory. This entry specifies the logging file name for the FHIR API, using the environment variable @env.FHIR_API_LOGGING_FILE_NAME@. There are no other modifications to existing configurations or parameters.

Changes

File Path Change Summary
src/main/environment/common_ci.properties Added logging file name configuration: [email protected]_API_LOGGING_FILE_NAME@

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FHIR_API
    participant Logger

    User->>FHIR_API: Request data
    FHIR_API->>Logger: Log request details to @env.FHIR_API_LOGGING_FILE_NAME@
    Logger-->>FHIR_API: Confirm logging
    FHIR_API-->>User: Send response
Loading

Poem

In the code where changes bloom,
A logging file finds its room.
With every request, a tale to tell,
In FHIR's embrace, we log it well.
Hops of joy in the digital glade,
For clarity in logs, our efforts are laid! πŸ‡βœ¨

Warning

Rate limit exceeded

@ivor11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 1 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

Reviewing files that changed from the base of the PR and between 08a901b and 8bf093e.


πŸ“œ Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 08a901b and 8bf093e.

πŸ“’ Files selected for processing (1)
  • src/main/environment/common_ci.properties (1 hunks)
πŸ”‡ Additional comments (2)
src/main/environment/common_ci.properties (2)

89-90: LGTM! Clean addition of ELK logging configuration.

The new logging configuration follows the established patterns:

  • Properly grouped with existing logging settings
  • Uses consistent @env.VARIABLE_NAME@ syntax
  • Clear section header comment

90-90: Verify environment variable setup in CI pipeline.

Ensure that the FHIR_API_LOGGING_FILE_NAME environment variable is:

  1. Properly configured in your CI environment
  2. Set with appropriate file path permissions for log writing
βœ… Verification successful

Let me gather more information about the environment variable configuration.


Let me check one more thing to understand the Maven property resolution.


Environment variable configuration appears to be properly handled

The investigation reveals that:

  1. The logging file configuration has a default value in application.properties: logging.file.name=logs/fhir-api.log
  2. The @env.FHIR_API_LOGGING_FILE_NAME@ in common_ci.properties is a Maven property that allows overriding the default value in CI environments
  3. The property follows Spring Boot's standard logging configuration pattern
  4. File permissions will be handled by the application's runtime user, which is typically configured at the CI/CD platform level
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for environment variable usage in CI configuration files

# Look for the environment variable definition in CI files
echo "Searching for FHIR_API_LOGGING_FILE_NAME in CI configuration files..."
fd -t f "^\.?.*\.(yaml|yml|properties|env)$" | xargs rg "FHIR_API_LOGGING_FILE_NAME"

Length of output: 326


Script:

#!/bin/bash
# Check for environment variable in different configuration contexts

# Look for any Maven profiles or configuration that might set this variable
echo "Checking Maven configuration files..."
fd -t f "pom.xml" | xargs rg -A 5 "FHIR_API_LOGGING_FILE_NAME"

# Check for default values or configurations in application properties
echo "Checking application properties..."
fd -t f "application.*\.properties" | xargs rg "logging.file"

# Check for Docker configurations
echo "Checking Docker configurations..."
fd -t f "Dockerfile|docker-compose.*\.yml" | xargs rg "FHIR_API_LOGGING_FILE_NAME"

# Check for any shell scripts that might set this variable
echo "Checking shell scripts..."
fd -t f "\.sh$" | xargs rg "FHIR_API_LOGGING_FILE_NAME"

Length of output: 851


Script:

#!/bin/bash
# Check Maven profiles and property definitions

# Look for Maven profiles and property definitions in pom files
echo "Checking Maven profiles and properties..."
fd -t f "pom.xml" | xargs rg -A 10 "<properties>|<profiles>"

# Check for environment-specific property files
echo "Checking environment property files..."
fd -t f ".*environment.*\.properties" | xargs cat

Length of output: 747


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
πŸͺ§ 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.

Copy link

sonarqubecloud bot commented Dec 2, 2024

@drtechie drtechie merged commit 2f45084 into PSMRI:develop Dec 3, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants