All Products
Search
Document Center

OpenSearch:SDK log output

Last Updated:Mar 18, 2026

This topic provides an example of how to configure log output for the Java SDK.

Configure log output for debugging

  1. Ensure that the Java SDK dependency is in your pom.xml file. Then, add the following dependency:

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.12</version>
</dependency>
  1. Save the following content as a file named log4j.xml and place it in the root directory of your classpath.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d %-5p [%t] %c{1} - %m%n" />
        </layout>
    </appender>
    <appender name="logfile" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="log/sdk.log" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d %p [%c] - %m%n" />
        </layout>
    </appender>
    <logger name="com.aliyun.opensearch">
        <level value="debug" />
    </logger>
    <logger name="org.apache.thrift">
        <level value="error" />
    </logger>
    <root>
        <level value="info" />
        <appender-ref ref="console" />
        <appender-ref ref="logfile" />
    </root>
</log4j:configuration>
  1. (Optional) To change the location of the log output file, modify the value in the log4j.xml file to your destination path.

 <param name="File" value="log/sdk.log" />