本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 設定 Amazon EMR Serverless 的 Apache Log4j2 屬性
<a name="log4j2"></a>

此頁面說明如何為位於 的 EMR Serverless 任務設定自訂 [Apache Log4j 2.x 屬性。](https://logging.apache.org/log4j/2.x/) `StartJobRun`如果您想要在應用程式層級設定 Log4j 分類，請參閱 [EMR Serverless 的預設應用程式組態](default-configs.md)。

## 設定 Amazon EMR Serverless 的 Spark Log4j2 屬性
<a name="log4j2-spark"></a>

透過 Amazon EMR 6.8.0 版和更新版本，您可以自訂 [Apache Log4j 2.x](https://logging.apache.org/log4j/2.x/) 屬性來指定精細的日誌組態。這可簡化 EMR Serverless 上 Spark 任務的疑難排解。若要設定這些屬性，請使用 `spark-driver-log4j2`和 `spark-executor-log4j2`分類。

**Topics**
+ [Spark 的 Log4j2 分類](#log4j2-spark-class)
+ [Spark 的 Log4j2 組態範例](#log4j2-spark-example)
+ [範例 Spark 任務中的 Log4j2](#log4j2-spark-jobs)
+ [Spark 的 Log4j2 考量事項](#log4j2-spark-considerations)

### Spark 的 Log4j2 分類
<a name="log4j2-spark-class"></a>

若要自訂 Spark 日誌組態，請使用下列分類搭配 [https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_ConfigurationOverrides.html#emrserverless-Type-ConfigurationOverrides-applicationConfiguration](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_ConfigurationOverrides.html#emrserverless-Type-ConfigurationOverrides-applicationConfiguration)。若要設定 Log4j 2.x 屬性，請使用下列 [https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html#emrserverless-Type-Configuration-properties](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html#emrserverless-Type-Configuration-properties)。

**`spark-driver-log4j2`**  
此分類會為驅動程式設定 `log4j2.properties` 檔案中的值。

**`spark-executor-log4j2`**  
此分類會設定執行器`log4j2.properties`檔案中的值。

### Spark 的 Log4j2 組態範例
<a name="log4j2-spark-example"></a>

下列範例示範如何使用 提交 Spark 任務`applicationConfiguration`，以自訂 Spark 驅動程式和執行器的 Log4j2 組態。

若要在應用程式層級設定 Log4j 分類，而不是在您提交任務時設定，請參閱 [EMR Serverless 的預設應用程式組態](default-configs.md)。

```
aws emr-serverless start-job-run \
    --application-id application-id \
    --execution-role-arn job-role-arn \
    --job-driver '{
        "sparkSubmit": {
            "entryPoint": "/usr/lib/spark/examples/jars/spark-examples.jar",
            "entryPointArguments": ["1"],
            "sparkSubmitParameters": "--class org.apache.spark.examples.SparkPi --conf spark.executor.cores=4 --conf spark.executor.memory=20g --conf spark.driver.cores=4 --conf spark.driver.memory=8g --conf spark.executor.instances=1"
        }
    }'
    --configuration-overrides '{
        "applicationConfiguration": [
             {
                "classification": "spark-driver-log4j2",
                "properties": {
                    "rootLogger.level":"error", // will only display Spark error logs
                    "logger.IdentifierForClass.name": "classpath for setting logger",
                    "logger.IdentifierForClass.level": "info"
                   
                }
            },
            {
                "classification": "spark-executor-log4j2",
                "properties": {
                    "rootLogger.level":"error", // will only display Spark error logs
                    "logger.IdentifierForClass.name": "classpath for setting logger",
                    "logger.IdentifierForClass.level": "info"
                }
            }
       ]
    }'
```

### 範例 Spark 任務中的 Log4j2
<a name="log4j2-spark-jobs"></a>

下列程式碼範例示範如何在初始化應用程式的自訂 Log4j2 組態時建立 Spark 應用程式。

------
#### [ Python ]

**Example - 使用 Log4j2 搭配 Python 進行 Spark 任務**  

```
import os
import sys

from pyspark import SparkConf, SparkContext
from pyspark.sql import SparkSession

app_name = "PySparkApp"
if __name__ == "__main__":
    spark = SparkSession\
        .builder\
        .appName(app_name)\
        .getOrCreate()
    
    spark.sparkContext._conf.getAll()
    sc = spark.sparkContext
    log4jLogger = sc._jvm.org.apache.log4j
    LOGGER = log4jLogger.LogManager.getLogger(app_name)

    LOGGER.info("pyspark script logger info")
    LOGGER.warn("pyspark script logger warn")
    LOGGER.error("pyspark script logger error")
    
    // your code here
    
    spark.stop()
```
若要在執行 Spark 任務時自訂驅動程式的 Log4j2，請使用下列組態：  

```
{
   "classification": "spark-driver-log4j2",
      "properties": {
          "rootLogger.level":"error", // only display Spark error logs
          "logger.PySparkApp.level": "info", 
          "logger.PySparkApp.name": "PySparkApp"
      }
}
```

------
#### [ Scala ]

**Example - 使用 Log4j2 搭配 Scala 進行 Spark 任務**  

```
import org.apache.log4j.Logger
import org.apache.spark.sql.SparkSession

object ExampleClass {
  def main(args: Array[String]): Unit = {
    val spark = SparkSession
    .builder
    .appName(this.getClass.getName)
    .getOrCreate()

    val logger = Logger.getLogger(this.getClass);
    logger.info("script logging info logs")
    logger.warn("script logging warn logs")
    logger.error("script logging error logs")

// your code here
    spark.stop()
  }
}
```
若要在執行 Spark 任務時自訂驅動程式的 Log4j2，請使用下列組態：  

```
{
   "classification": "spark-driver-log4j2",
      "properties": {
          "rootLogger.level":"error", // only display Spark error logs
          "logger.ExampleClass.level": "info", 
          "logger.ExampleClass.name": "ExampleClass"
      }
}
```

------

### Spark 的 Log4j2 考量事項
<a name="log4j2-spark-considerations"></a>

Spark 程序無法設定下列 Log4j2.x 屬性：
+ `rootLogger.appenderRef.stdout.ref`
+ `appender.console.type`
+ `appender.console.name`
+ `appender.console.target`
+ `appender.console.layout.type`
+ `appender.console.layout.pattern`

如需設定之 Log4j2.x 屬性的詳細資訊，請參閱 GitHub 上的 [`log4j2.properties.template` 檔案](https://github.com/apache/spark/blob/v3.3.0/conf/log4j2.properties.template)。