Rat (Release Audit Tool) results
The following document contains the results of Rat (Release Audit Tool).
*****************************************************
Summary
-------
Generated at: 2026-11-02T10:24:59Z
Notes: 0
Binaries: 0
Archives: 0
Standards: 2
Apache Licensed: 1
Generated Documents: 0
JavaDocs are generated, thus a license header is optional.
Generated files do not require license headers.
1 Unknown Licenses
*****************************************************
Files with unapproved licenses:
/home/runner/work/shardingsphere-doc/shardingsphere-doc/shardingsphere/agent/README.md
*****************************************************
*****************************************************
Files with Apache License headers will be marked AL
Binary files (which do not require any license headers) will be marked B
Compressed archives will be marked A
Notices, licenses etc. will be marked N
!????? /home/runner/work/shardingsphere-doc/shardingsphere-doc/shardingsphere/agent/README.md
AL /home/runner/work/shardingsphere-doc/shardingsphere-doc/shardingsphere/agent/pom.xml
*****************************************************
Printing headers for text files without a valid license header...
=====================================================
== File: /home/runner/work/shardingsphere-doc/shardingsphere-doc/shardingsphere/agent/README.md
=====================================================
# ShardingSphere Agent
ShardingSphere-Agent module provides an observable framework for ShardingSphere, which is implemented based on Java Agent.
## Features
### Logging
The logging plugin uses to record logs of ShardingSphere.
Support for File.
### Metrics
The metrics plugin uses to collect and expose monitoring metrics.
Support for prometheus.
### Tracing
The tracing plugin uses to obtain the link trace information of SQL parsing and SQL execution.
Support for OpenTelemetry.
## How To Build
```shell
git clone https://github.com/apache/shardingsphere.git
cd shardingsphere
./mvnw clean install -P-dev,release,all
```
Artifact is `distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz`
## Quick Start
* `shardingsphere-agent-{latest.release.version}.jar` is the agent startup jar.
* `conf/agent.yaml` is used to configure and enable plugins.
### Quick Start with Proxy
Add the agent to the Proxy directory, as follows:
```shell
apache-shardingsphere-{latest.release.version}-shardingsphere-proxy-bin/agent/shardingsphere-agent.jar
```
Start agent with `-g` option by bin/start.sh
```shell
sh start.sh -g
# following command also works
sh start.sh --agent