传输协议

HTTPS

使用前提

• 使用云日志SDK前，您需要注册华为云帐号且开通云日志服务。
• 在云日志服务中已创建日志组（LogGroup）以及日志流（LogStream）。
• 云日志服务SDK目前仅支持logback 1.1.11和logback 1.2.3版本。

使用步骤

1. 下载并安装日志SDK包。
   1. 下载云日志服务Java SDK（logback插件）。
   2. 下载后解压到指定目录。注：直接解压即可，不需要额外操作。
   3. 将解压后的所有jar包添加到您的java工程，并配置logback.xml文件。

2. 配置logback.xml。

   //配置自定义appender作用的package范围，将{xxx}配置为希望上报日志的package。
   <configuration scan="true" debug="false">
       <property name="PROJECT_NAME" value="test"/>
       <contextName>${PROJECT_NAME}</contextName>
       <appender name="CustomAppender" class="com.huawei.appender.LogbackSDKAppender">
           <appName>${PROJECT_NAME}</appName>
            <!--上报日志所属日志服务的日志组ID(必选)-->
           <loggroupid>xxxx-xxxx-xxx</loggroupid>
            <!--上报日志所属日志服务的日志流ID(必选)-->
            <logstreamid>xxxx-xxxx-xxx</logstreamid>
            <!--上报日志所属日志服务的项目id (必选)-->
            <projectid>xxxxxxxxxxxxxxxxxyyyyyyyyyyyy</projectid>
            <!--当前租户的access key (必选)-->
            <ak>XXXXXXXXXXXXXXXXXXXX</ak>
            <!--当前租户的访问密钥secret access key(必选)-->
            <sk>XXXXXXXXXXXXXXXXXXXX</sk>
            <!--对应region上报日志的地址(必选)-->                  
           <endpoint>10.63.x.xxx:xxxxx</endpoint>
            <!--对应iam服务的鉴权地址(必选)-->                  
            <iamendpoint>10.63.x.x:xxxx</iamendpoint>
            <!--发送日志的应用所在节点ip（可选)-->                  
            <hostip>1.1.1.1</hostip>
            <!--发送日志的应用所在节点name（可选)-->                  
            <hostname>loacl</hostname>
            <!--日志批量上报的条数大小（可选)-->                  
            <batchsize>100</batchsize>
            <!--日志上报的并发线程（可选)-->                  
            <threadcount>1</threadcount>
            <!—日志上报的队列大小（可选）-->                  
            <dataqueuesize>10000</dataqueuesize>
       <!-- Optional parameters -->
       <encoder>
           <pattern>%d %-5level [%thread] %logger{0}: %msg</pattern>
       </encoder>
       
       <!--  Optional parameters -->
       <timeFormat>yyyy-MM-dd'T'HH:mmZ</timeFormat>
       <!--  Optional parameters -->
       <timeZone>UTC</timeZone>
       </appender>
       <logger name="huawei.sdk.test" level="INFO">
           <appender-ref ref="CustomAppender"/>
       </logger>
   </configuration>

   

   logback.xml不能更改名称，否则初始化时无法读取到相关配置信息。

3. 使用示例

   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
    
   public class testAppender 
   {
       private static final Logger LOGGER =       LoggerFactory.getLogger(testAppender.class);
   public static void main(String[] args) 
   {
           LOGGER.info("test log appender");
       }
   }
   说明：云日志SDK中使用了LoggerFactory相关方法打印error级别和debug级别的日志，建议单独设置com.huawei包的日志输出目录。如果需要关闭com.huawei的日志打印，请配置：
       <logger name="packname" level="OFF">
           </logger>

参数获取方法

• 日志组ID：登录云日志服务页面，选择日志管理，日志组名称下面的ID即为日志组ID。

  

• 日志流ID：单击日志组名称，跳转至日志流列表，日志流名称下面的ID即为日志流ID。

  

• 项目ID/ProjectID：请参见“我的凭证 > API凭证”。
• 访问密钥access key（AK）/secret access key（SK），请参见“我的凭证 > 访问密钥 ”。
• 上报日志地址Endpont：不同服务不同区域的上报地址不同，请联系华为工程师。
• IAM 鉴权地址如下表所示：

  区域名称	区域	终端节点（Endpoint）	协议类型
  global	global	iam.myhuaweicloud.com	HTTPS
  华北-北京二	cn-north-2	iam.cn-north-2.myhuaweicloud.com	HTTPS
  华北-北京四	cn-north-4	iam.cn-north-4.myhuaweicloud.com	HTTPS
  华北-北京一	cn-north-1	iam.cn-north-1.myhuaweicloud.com	HTTPS
  华东-上海二	cn-east-2	iam.cn-east-2.myhuaweicloud.com	HTTPS
  华东-上海一	cn-east-3	iam.cn-east-3.myhuaweicloud.com	HTTPS
  华南-广州	cn-south-1	iam.cn-south-1.myhuaweicloud.com	HTTPS
  华南-深圳	cn-south-2	iam.cn-south-2.myhuaweicloud.com	HTTPS
  西南-贵阳一	cn-southwest-2	iam.cn-southwest-2.myhuaweicloud.com	HTTPS