This is an automated email from the ASF dual-hosted git repository.
zhangliang 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 673c9406725 add readme.txt forr agent (#23978)
673c9406725 is described below
commit 673c9406725355595c7bddc10721c154f578a76d
Author: jiangML <[email protected]>
AuthorDate: Fri Feb 3 20:14:33 2023 +0800
add readme.txt forr agent (#23978)
---
.../shardingsphere-agent-binary-distribution.xml | 7 +++++
.../agent/src/main/release-docs/README.txt | 32 ++++++++++++++++++++++
2 files changed, 39 insertions(+)
diff --git
a/distribution/agent/src/main/assembly/shardingsphere-agent-binary-distribution.xml
b/distribution/agent/src/main/assembly/shardingsphere-agent-binary-distribution.xml
index 2af0035e8ca..a85c6e2c557 100644
---
a/distribution/agent/src/main/assembly/shardingsphere-agent-binary-distribution.xml
+++
b/distribution/agent/src/main/assembly/shardingsphere-agent-binary-distribution.xml
@@ -39,6 +39,13 @@
<include>NOTICE</include>
</includes>
</fileSet>
+ <fileSet>
+ <directory>src/main/release-docs</directory>
+ <includes>
+ <include>**/*</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
<fileSet>
<directory>../../agent/plugins/core/target/lib</directory>
diff --git a/distribution/agent/src/main/release-docs/README.txt
b/distribution/agent/src/main/release-docs/README.txt
new file mode 100644
index 00000000000..ac17466e43a
--- /dev/null
+++ b/distribution/agent/src/main/release-docs/README.txt
@@ -0,0 +1,32 @@
+Welcome to Apache ShardingSphere Agent
+===============================================================================
+
+Apache ShardingSphere Agent is used to collect relevant monitoring data
generated when Apache ShardingSphere is running, including Loggin, Metrics, and
Tracing.
+
+- `Logging` The log can be easily expanded through the agent to provide more
information for analyzing the system running status.
+- `Metrics` System statistical indicators are collected through probes for
display by third-party applications.
+- `Tracing` Tracing data between distributed services or internal processes
will be collected by agent. It will then be sent to third-party APM systems.
+
+Getting Started
+===============================================================================
+To help you get started, try the following links:
+
+Getting Started
+
https://shardingsphere.apache.org/document/current/cn/user-manual/shardingsphere-proxy/observability/
+
+We welcome contributions of all kinds, for details of how you can help
+ https://shardingsphere.apache.org/community/en/involved/
+
+Find the issue tracker from here
+ https://github.com/apache/shardingsphere/issues
+
+Please help us make Apache ShardingSphere better - we appreciate any feedback
you may have.
+
+Have fun!
+
+-----------------
+
+Licensing
+===============================================================================
+
+This software is licensed under the terms you may find in the file named
"LICENSE" in this directory.
