You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by "FrankYang0529 (via GitHub)" <gi...@apache.org> on 2023/06/30 06:45:34 UTC
[GitHub] [yunikorn-site] FrankYang0529 opened a new pull request, #322: [YUNIKORN-1824] add log.{subsystem}.level
FrankYang0529 opened a new pull request, #322:
URL: https://github.com/apache/yunikorn-site/pull/322
### What is this PR for?
Add scoped logging setting.
### What type of PR is it?
* [ ] - Bug Fix
* [ ] - Improvement
* [ ] - Feature
* [X] - Documentation
* [ ] - Hot Fix
* [ ] - Refactoring
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-1824
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* [ ] - The licenses files need update.
* [ ] - There is breaking changes for older versions.
* [ ] - It needs documentation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] craigcondit closed pull request #322: [YUNIKORN-1824] add log.{subsystem}.level
Posted by "craigcondit (via GitHub)" <gi...@apache.org>.
craigcondit closed pull request #322: [YUNIKORN-1824] add log.{subsystem}.level
URL: https://github.com/apache/yunikorn-site/pull/322
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] FrankYang0529 commented on pull request #322: [YUNIKORN-1824] add log.{subsystem}.level
Posted by "FrankYang0529 (via GitHub)" <gi...@apache.org>.
FrankYang0529 commented on PR #322:
URL: https://github.com/apache/yunikorn-site/pull/322#issuecomment-1618146704
@craigcondit, I updated the PR. Please help me review it again. Thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] craigcondit commented on a diff in pull request #322: [YUNIKORN-1824] add log.{subsystem}.level
Posted by "craigcondit (via GitHub)" <gi...@apache.org>.
craigcondit commented on code in PR #322:
URL: https://github.com/apache/yunikorn-site/pull/322#discussion_r1248028257
##########
docs/user_guide/service_config.md:
##########
@@ -704,6 +704,89 @@ Example:
```yaml
log.level: "-1"
```
+
+#### log.{subsystem}.level
+Sets the verbosity that YuniKorn subsystem will log at.
+
+Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
+setting an entry for `log.core.level` will configure all loggers that start with `core.`
+(including `core.scheduler`, etc.) unless a more specific configuration is present.
+Each subsystem has its log level. The `{subsystem}` values are:
+
+- admission
Review Comment:
Given the length of this list, maybe it makes sense to format it as a footnote. This will keep the full list out of the main configuration entry. We can still provide examples.
##########
docs/user_guide/service_config.md:
##########
@@ -704,6 +704,89 @@ Example:
```yaml
log.level: "-1"
```
+
+#### log.{subsystem}.level
+Sets the verbosity that YuniKorn subsystem will log at.
+
+Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
+setting an entry for `log.core.level` will configure all loggers that start with `core.`
+(including `core.scheduler`, etc.) unless a more specific configuration is present.
+Each subsystem has its log level. The `{subsystem}` values are:
+
+- admission
+- admission.client
+- admission.conf
+- admission.utils
+- admission.webhook
+- core
+- core.config
+- core.entrypoint
+- core.events
+- core.metrics
+- core.opentracing
+- core.resources
+- core.rest
+- core.rmproxy
+- core.rpc
+- core.scheduler
+- core.scheduler.allocation
+- core.scheduler.application
+- core.scheduler.application.usage
+- core.scheduler.context
+- core.scheduler.fsm
+- core.scheduler.health
+- core.scheduler.node
+- core.scheduler.partition
+- core.scheduler.preemption
+- core.scheduler.queue
+- core.scheduler.reservation
+- core.scheduler.ugm
+- core.security
+- core.utils
+- deprecation
+- kubernetes
+- shim
+- shim.appmgmt
+- shim.appmgmt.general
+- shim.appmgmt.sparkoperator
+- shim.cache.application
+- shim.cache.external
+- shim.cache.node
+- shim.cache.placeholder
+- shim.cache.task
+- shim.client
+- shim.config
+- shim.context
+- shim.dispatcher
+- shim.framework
+- shim.fsm
+- shim.predicates
+- shim.resources
+- shim.rmcallback
+- shim.scheduler
+- shim.scheduler.plugin
+- shim.utils
+
+A change to this setting will be picked up without a restart of YuniKorn. The available
+values are:
+
+ - `-1`: Debug
+ - `0`: Info
+ - `1`: Warn
+ - `2`: Error
+ - `3`: DPanic
+ - `4`: Panic
+ - `5`: Fatal
+
+Default: `0` (Info)
+
+Example:
+```yaml
+log.admission.level: "-1"
Review Comment:
Let's use the textual values instead of numeric as both are supported, but the textual ones are much easier to read:
```
log.level: INFO
log.admission.level: DEBUG
log.core.config.level: INFO
log.shim.appmgmt.sparkoperator.level: ERROR
```
##########
docs/user_guide/service_config.md:
##########
@@ -704,6 +704,89 @@ Example:
```yaml
log.level: "-1"
Review Comment:
We should update the description of `log.level` to indicate that textual values are now allowed (as are the numeric values) but update the examples to use the textual values since they are easier to read.
We should also update the description from "Sets the verbosity that YuniKorn will log at." to "Sets the *default* verbosity that YuniKorn will log at."
##########
docs/user_guide/service_config.md:
##########
@@ -704,6 +704,89 @@ Example:
```yaml
log.level: "-1"
```
+
+#### log.{subsystem}.level
+Sets the verbosity that YuniKorn subsystem will log at.
+
+Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
+setting an entry for `log.core.level` will configure all loggers that start with `core.`
+(including `core.scheduler`, etc.) unless a more specific configuration is present.
+Each subsystem has its log level. The `{subsystem}` values are:
+
+- admission
+- admission.client
+- admission.conf
+- admission.utils
+- admission.webhook
+- core
+- core.config
+- core.entrypoint
+- core.events
+- core.metrics
+- core.opentracing
+- core.resources
+- core.rest
+- core.rmproxy
+- core.rpc
+- core.scheduler
+- core.scheduler.allocation
+- core.scheduler.application
+- core.scheduler.application.usage
+- core.scheduler.context
+- core.scheduler.fsm
+- core.scheduler.health
+- core.scheduler.node
+- core.scheduler.partition
+- core.scheduler.preemption
+- core.scheduler.queue
+- core.scheduler.reservation
+- core.scheduler.ugm
+- core.security
+- core.utils
+- deprecation
+- kubernetes
+- shim
+- shim.appmgmt
+- shim.appmgmt.general
+- shim.appmgmt.sparkoperator
+- shim.cache.application
+- shim.cache.external
+- shim.cache.node
+- shim.cache.placeholder
+- shim.cache.task
+- shim.client
+- shim.config
+- shim.context
+- shim.dispatcher
+- shim.framework
+- shim.fsm
+- shim.predicates
+- shim.resources
+- shim.rmcallback
+- shim.scheduler
+- shim.scheduler.plugin
+- shim.utils
+
+A change to this setting will be picked up without a restart of YuniKorn. The available
+values are:
+
+ - `-1`: Debug
+ - `0`: Info
+ - `1`: Warn
+ - `2`: Error
+ - `3`: DPanic
+ - `4`: Panic
+ - `5`: Fatal
+
+Default: `0` (Info)
Review Comment:
We should also point out that the textual entries are also allowed.
##########
docs/user_guide/service_config.md:
##########
@@ -704,6 +704,89 @@ Example:
```yaml
log.level: "-1"
```
+
+#### log.{subsystem}.level
+Sets the verbosity that YuniKorn subsystem will log at.
+
+Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
+setting an entry for `log.core.level` will configure all loggers that start with `core.`
+(including `core.scheduler`, etc.) unless a more specific configuration is present.
+Each subsystem has its log level. The `{subsystem}` values are:
+
+- admission
+- admission.client
+- admission.conf
+- admission.utils
+- admission.webhook
+- core
+- core.config
+- core.entrypoint
+- core.events
+- core.metrics
+- core.opentracing
+- core.resources
+- core.rest
+- core.rmproxy
+- core.rpc
+- core.scheduler
+- core.scheduler.allocation
+- core.scheduler.application
+- core.scheduler.application.usage
+- core.scheduler.context
+- core.scheduler.fsm
+- core.scheduler.health
+- core.scheduler.node
+- core.scheduler.partition
+- core.scheduler.preemption
+- core.scheduler.queue
+- core.scheduler.reservation
+- core.scheduler.ugm
+- core.security
+- core.utils
+- deprecation
+- kubernetes
+- shim
+- shim.appmgmt
+- shim.appmgmt.general
+- shim.appmgmt.sparkoperator
+- shim.cache.application
+- shim.cache.external
+- shim.cache.node
+- shim.cache.placeholder
+- shim.cache.task
+- shim.client
+- shim.config
+- shim.context
+- shim.dispatcher
+- shim.framework
+- shim.fsm
+- shim.predicates
+- shim.resources
+- shim.rmcallback
+- shim.scheduler
+- shim.scheduler.plugin
+- shim.utils
+
+A change to this setting will be picked up without a restart of YuniKorn. The available
+values are:
+
+ - `-1`: Debug
+ - `0`: Info
+ - `1`: Warn
+ - `2`: Error
+ - `3`: DPanic
+ - `4`: Panic
+ - `5`: Fatal
+
+Default: `0` (Info)
+
+Example:
+```yaml
Review Comment:
Let's show `log.level` in the example as well, and also describe that it acts as the default log level for all loggers.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org