文档首页 > > 用户指南> SDK参考> 云日志服务Java SDK(logback插件)

云日志服务Java SDK(logback插件)

分享
更新时间:2020/07/20 GMT+08:00

云日志服务Java SDK提供了与logback适配的扩展插件,可以直接在logback中配置华为云appender,将通过logback产生的日志直接上报至云日志服务。

传输协议

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:请参见:我的凭证 用户指南。
  • 访问密钥access key(AK)/secret access key(SK),请参见:我的凭证 用户指南。
  • 区域、IAM 鉴权地址和上报日志地址请参见下表:

    区域

    名称

    IAM鉴权地址

    上报日志地址

    华北-北京一

    cn-north-1

    iam.cn-north-1.myhuaweicloud.com

    请联系华为工程师获取

    华北-北京四

    cn-north-4

    iam.cn-north-4.myhuaweicloud.com

    请联系华为工程师获取

    华南-广州一

    cn-south-1

    iam.cn-south-1.myhuaweicloud.com

    请联系华为工程师获取

    华东-上海二

    cn-east-2

    iam.cn-east-2.myhuaweicloud.com

    请联系华为工程师获取

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问