You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "gengliangwang (via GitHub)" <gi...@apache.org> on 2024/03/29 06:08:59 UTC
[PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
gengliangwang opened a new pull request, #45770:
URL: https://github.com/apache/spark/pull/45770
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Implement logWarning API in structured logging framework. Also, refactor the logging test suites to reduce duplicated code.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
To enhance Apache Spark's logging system by implementing structured logging.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
No
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
New unit tests
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
No
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang commented on code in PR #45770:
URL: https://github.com/apache/spark/pull/45770#discussion_r1546578416
##########
common/utils/src/test/scala/org/apache/spark/util/StructuredLoggingSuite.scala:
##########
@@ -45,39 +45,67 @@ abstract class LoggingSuiteBase extends AnyFunSuite // scalastyle:ignore funsuit
val newContent = Files.readString(logFile.toPath)
newContent.substring(content.length)
}
-}
-class StructuredLoggingSuite extends LoggingSuiteBase {
- private val className = this.getClass.getName.stripSuffix("$")
- override def logFilePath: String = "target/structured.log"
+ def basicMsg: String = "This is a log message"
+
+ def msgWithMDC: LogEntry = log"Lost executor ${MDC(EXECUTOR_ID, "1")}."
+
+ def msgWithMDCAndException: LogEntry = log"Error in executor ${MDC(EXECUTOR_ID, "1")}."
Review Comment:
When logging with an exception, the output will contain the field "exception".
{"ts":"2024-04-01T09:43:18.892-0700","level":"ERROR","msg":"Error in executor 1.","context":{"executor_id":"1"},"exception":{"class":"java.lang.RuntimeException","msg":"OOM","stacktrace":"..."},"logger":"org.apache.spark.util.StructuredLoggingSuite"}
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang commented on PR #45770:
URL: https://github.com/apache/spark/pull/45770#issuecomment-2027565612
@ueshin Thanks for the review.
Merging to master
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang commented on code in PR #45770:
URL: https://github.com/apache/spark/pull/45770#discussion_r1546883300
##########
common/utils/src/test/scala/org/apache/spark/util/StructuredLoggingSuite.scala:
##########
@@ -45,39 +45,67 @@ abstract class LoggingSuiteBase extends AnyFunSuite // scalastyle:ignore funsuit
val newContent = Files.readString(logFile.toPath)
newContent.substring(content.length)
}
-}
-class StructuredLoggingSuite extends LoggingSuiteBase {
- private val className = this.getClass.getName.stripSuffix("$")
- override def logFilePath: String = "target/structured.log"
+ def basicMsg: String = "This is a log message"
+
+ def msgWithMDC: LogEntry = log"Lost executor ${MDC(EXECUTOR_ID, "1")}."
+
+ def msgWithMDCAndException: LogEntry = log"Error in executor ${MDC(EXECUTOR_ID, "1")}."
Review Comment:
Yes, we can make it `msgWithMDC2`, or reuse `msgWithMDC` and remove `msgWithMDCAndException`.
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang closed pull request #45770: [SPARK-47575][INFRA] Implement logWarning API in structured logging framework
URL: https://github.com/apache/spark/pull/45770
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "tgravescs (via GitHub)" <gi...@apache.org>.
tgravescs commented on code in PR #45770:
URL: https://github.com/apache/spark/pull/45770#discussion_r1546647354
##########
common/utils/src/test/scala/org/apache/spark/util/StructuredLoggingSuite.scala:
##########
@@ -45,39 +45,67 @@ abstract class LoggingSuiteBase extends AnyFunSuite // scalastyle:ignore funsuit
val newContent = Files.readString(logFile.toPath)
newContent.substring(content.length)
}
-}
-class StructuredLoggingSuite extends LoggingSuiteBase {
- private val className = this.getClass.getName.stripSuffix("$")
- override def logFilePath: String = "target/structured.log"
+ def basicMsg: String = "This is a log message"
+
+ def msgWithMDC: LogEntry = log"Lost executor ${MDC(EXECUTOR_ID, "1")}."
+
+ def msgWithMDCAndException: LogEntry = log"Error in executor ${MDC(EXECUTOR_ID, "1")}."
Review Comment:
Ok but the function itself doesn't have an exception in it, this just seems to be another string with MDC which is just different text then msgWithMDC looking at where you use it I see the message copied into expectedPatternForMsgWithMDCAndException and then this passed into "Logging with MDC and Exception"... why isn't this just called msgWithMDC2 since this function itself doesn't take an exception or add any functionality related to an exception
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-47575][INFRA] Implement logWarning API in structured logging framework [spark]
Posted by "tgravescs (via GitHub)" <gi...@apache.org>.
tgravescs commented on code in PR #45770:
URL: https://github.com/apache/spark/pull/45770#discussion_r1546352517
##########
common/utils/src/test/scala/org/apache/spark/util/StructuredLoggingSuite.scala:
##########
@@ -45,39 +45,67 @@ abstract class LoggingSuiteBase extends AnyFunSuite // scalastyle:ignore funsuit
val newContent = Files.readString(logFile.toPath)
newContent.substring(content.length)
}
-}
-class StructuredLoggingSuite extends LoggingSuiteBase {
- private val className = this.getClass.getName.stripSuffix("$")
- override def logFilePath: String = "target/structured.log"
+ def basicMsg: String = "This is a log message"
+
+ def msgWithMDC: LogEntry = log"Lost executor ${MDC(EXECUTOR_ID, "1")}."
+
+ def msgWithMDCAndException: LogEntry = log"Error in executor ${MDC(EXECUTOR_ID, "1")}."
Review Comment:
so I'm a little confused by this, it has basically just text in it like msgWithMDC so where is the "AndException" part?
--
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@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org