fix：Optimize the default log path configuration

youngzil commented 1 month ago

What's the purpose of this PR

Optimize the default log path configuration

Which issue(s) this PR fixes:

Fixes #

Brief changelog

XXXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

[ ] Read the Contributing Guide before making this pull request.
[ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
[ ] Write necessary unit tests to verify the code.
[ ] Run mvn clean test to make sure this pull request doesn't break anything.
[ ] Update the CHANGES log.

Summary by CodeRabbit

New Features
- Enhanced logging configuration for improved flexibility in log management.
Documentation
- Updated Apollo development guides for clearer local setup instructions, including database requirements and running configurations.
- Corrected default log output path and clarified service health verification steps.

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request updates the documentation for local development in both English and Chinese, enhancing clarity regarding the setup requirements, particularly emphasizing the necessity of MySQL for database creation. Instructions for running configurations and verifying service health have been detailed. Additionally, the logging file paths in application.yml and configservice.properties have been simplified by removing a numeric directory component. No alterations were made to exported or public entity declarations.

Changes

File Path	Change Summary
`apollo-assembly/src/main/resources/application.yml`	Updated logging file path: `/opt/logs/100003171/apollo-assembly.log` → `/opt/logs/apollo-assembly.log`.
`apollo-configservice/src/main/resources/configservice.properties`	Updated logging file path: `/opt/logs/100003171/apollo-configservice.log` → `/opt/logs/apollo-configservice.log`.
`docs/en/contribution/apollo-development-guide.md`	Enhanced clarity on local development setup, updated requirements, and detailed instructions.
`docs/zh/contribution/apollo-development-guide.md`	Enhanced clarity on local development setup, updated requirements, and detailed instructions.

Possibly related PRs

5247: The changes in the main PR regarding the documentation of MySQL requirements and local development setup are related to the enhancements made in the ConfigService to monitor cache statistics, as both involve improving the configuration and operational aspects of the Apollo system.

Suggested labels

size:L, lgtm

Suggested reviewers

nobodyiam

Poem

In the burrow where logs do flow,
Paths and names now clearly show.
With guides in hand, we leap and bound,
In Apollo's world, new joys abound! 🐇✨
MySQL or H2, we choose with glee,
Configurations set, oh what a spree!

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 6857debf305b9779e37980858e0480c87bac2c19 and 3262f28344e31d173a775c990582514194ef88c7.

📒 Files selected for processing (1)

* apollo-configservice/src/main/resources/configservice.properties (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

apollo-configservice/src/main/resources/configservice.properties (1)
`19-19`: _:warning: Potential issue_ **Consider using environment-specific log paths** While simplifying the log path is good, using `/opt/logs` directly may cause permission issues in local development environments. Consider: 1. Using a relative path for local development 2. Leveraging Spring profiles to handle different environments 3. Using system properties or environment variables for flexibility Example configuration approach: ```properties # Default fallback for local development logging.file.name=./logs/apollo-configservice.log # Can be overridden via environment-specific properties files # configservice-{profile}.properties ``` Let's check if there are any environment-specific configurations already in place:

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

nobodyiam commented 1 month ago

Is it only for local development? As there are logics to create the log folders in the startup.sh

https://github.com/apolloconfig/apollo/blob/4bdf66a62ad0ec30d06083b658935bfe7a245760/apollo-portal/src/main/scripts/startup.sh#L23-L26

youngzil commented 1 month ago

Is it only for local development? As there are logics to create the log folders in the startup.sh

https://github.com/apolloconfig/apollo/blob/4bdf66a62ad0ec30d06083b658935bfe7a245760/apollo-portal/src/main/scripts/startup.sh#L23-L26

Yes, it is currently a problem in local development

nobodyiam commented 1 month ago

It doesn't work for me. The apollo-assembly.log was created in the current folder, likely because the /opt directory requires root access for creation. Additionally, I don't think this's an essential feature so I would prefer leaving it as is. However, it's nice to change the assembly log file to /opt/logs/apollo-assembly.log.

youngzil commented 1 month ago

It doesn't work for me. The apollo-assembly.log was created in the current folder, likely because the /opt directory requires root access for creation. Additionally, I don't think this's an essential feature so I would prefer leaving it as is. However, it's nice to change the assembly log file to /opt/logs/apollo-assembly.log.

Hi, you are right. I did a test and changed the path to a non-existent path under $HOME and found that it can start normally. So I'm going to revert this change

apolloconfig / apollo