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

Document error for agent config file 's config description #3943

Merged
merged 5 commits into from
Nov 27, 2019

Conversation

seifeHu
Copy link
Contributor

@seifeHu seifeHu commented Nov 27, 2019

Bug fix

In
https://github.com/apache/skywalking/blob/v6.5.0/docs/en/setup/service-agent/java-agent/README.md

logging.dir Log files directory. Default is blank string, means, use "system.out" to output logs. ""

logging.dir 's Description is an Error .Default value is not System.out. It is a dir.
logging.dir 's Description is an Error .Default value is not System.out. It is a dir.
@seifeHu seifeHu changed the title Patch 1 Document error for agent config file 's config description Nov 27, 2019
Copy link
Contributor Author

@seifeHu seifeHu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the description is an Error .In fact, the log will be output to the "agentJarDir/logs "
So It is needed to be fixed .

@@ -93,7 +93,7 @@ property key | Description | Default |
`logging.level`|The log level. Default is debug.|`DEBUG`|
`logging.file_name`|Log file name.|`skywalking-api.log`|
`logging.output`| Log output. Default is FILE. Use CONSOLE means output to stdout. |`FILE`|
`logging.dir`|Log files directory. Default is blank string, means, use "system.out" to output logs.|`""`|
`logging.dir`|Log files directory. Default is blank string, means, use "{theSkywalkingAgentJarDir}/logs " to output logs. {theSkywalkingAgentJarDir} is the directory where the skywalking agent jar file is located |`""`|
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the description is an Error .In fact, the log will be output to the "agentJarDir/logs "

@wu-sheng
Copy link
Member

The class comment is wrong too, org.apache.skywalking.apm.agent.core.conf.Config#Logging#DIR. Could you fix this too?

@wu-sheng wu-sheng added this to the 6.6.0 milestone Nov 27, 2019
@wu-sheng wu-sheng added bug Something isn't working and you are sure it's a bug! documentation Provide documents related issue or pull request only. labels Nov 27, 2019
the comments is an Error . fix it .
@seifeHu
Copy link
Contributor Author

seifeHu commented Nov 27, 2019

The class comment is wrong too, org.apache.skywalking.apm.agent.core.conf.Config#Logging#DIR. Could you fix this too?

ok . I pull an other pull request

#3947

@wu-sheng
Copy link
Member

This one is good, you don't need a new one.

@wu-sheng wu-sheng merged commit 0020b03 into apache:master Nov 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working and you are sure it's a bug! documentation Provide documents related issue or pull request only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants