You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by ji...@apache.org on 2022/11/15 07:39:43 UTC
[shardingsphere] branch master updated: Add logging configuration document for Proxy (#22162)
This is an automated email from the ASF dual-hosted git repository.
jianglongtao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new a1de9c34e13 Add logging configuration document for Proxy (#22162)
a1de9c34e13 is described below
commit a1de9c34e13039fbc61c223624e150cdc9e07066
Author: ChenJiaHao <37...@users.noreply.github.com>
AuthorDate: Tue Nov 15 15:39:36 2022 +0800
Add logging configuration document for Proxy (#22162)
* Add logging manage document for Proxy
* Revise document
* Revises based on the document template
* Revises document
---
.../shardingsphere-proxy/logging/_index.cn.md | 65 +++++++++++++++++++++
.../shardingsphere-proxy/logging/_index.en.md | 66 ++++++++++++++++++++++
2 files changed, 131 insertions(+)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.cn.md
new file mode 100644
index 00000000000..e3cf142b9fc
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.cn.md
@@ -0,0 +1,65 @@
++++
+title = "日志配置"
+weight = 8
++++
+
+## 背景信息
+
+ShardingSphere 使用 Logback 进行日志管理，内部采用 Java SPI 提供默认日志配置，用户可以使用 XML 文件来配置自定义日志输出，Proxy 将优先读取 `conf` 目录下的 `logback.xml` 提供的日志配置。
+
+下面将介绍如何自定义日志配置。
+
+## 操作步骤
+
+1. 新建 `conf/logback.xml`
+
+根据需求自定义 logger 级别、pattern 等。
+> 建议在配置示例的基础上进行修改
+
+2. 查看日志
+
+ShardingSphere-Proxy 启动后，日志将输出到 `logs` 目录下，选择目标日志文件进行查看。
+
+### 配置示例
+
+```xml
+<?xml version="1.0"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<configuration>
+ <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n</pattern>
+ </encoder>
+ </appender>
+ <logger name="org.apache.shardingsphere" level="info" additivity="false">
+ <appender-ref ref="console" />
+ </logger>
+
+ <logger name="com.zaxxer.hikari" level="error" />
+
+ <logger name="com.atomikos" level="error" />
+
+ <logger name="io.netty" level="error" />
+
+ <root>
+ <level value="info" />
+ <appender-ref ref="console" />
+ </root>
+</configuration>
+```
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.en.md
new file mode 100644
index 00000000000..405203e140c
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/logging/_index.en.md
@@ -0,0 +1,66 @@
++++
+title = "Logging Configuration"
+weight = 8
++++
+
+## Background
+
+ShardingSphere uses Logback for log management, and uses Java SPI internally to provide default log configuration. Users can use XML files to configure customized log output. Proxy will preferentially read the log configuration provided in `logback.xml` in the `/conf` directory.
+
+The following describes how to customize the log configuration.
+
+## Procedure
+
+1. Create file `conf/logback.xml`
+
+Customize the logger level and pattern, etc. according to your needs.
+> It is recommended to make modifications based on the configuration example
+
+2. View logs
+
+After ShardingSphere-Proxy starts, the log will be output to the `logs` directory, select the target log file to view.
+
+### Sample
+
+```xml
+<?xml version="1.0"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
+<configuration>
+ <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+ <encoder>
+ <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n</pattern>
+ </encoder>
+ </appender>
+ <logger name="org.apache.shardingsphere" level="info" additivity="false">
+ <appender-ref ref="console" />
+ </logger>
+
+ <logger name="com.zaxxer.hikari" level="error" />
+
+ <logger name="com.atomikos" level="error" />
+
+ <logger name="io.netty" level="error" />
+
+ <root>
+ <level value="info" />
+ <appender-ref ref="console" />
+ </root>
+</configuration>
+
+```