Observability

    Artifact is distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz

    Directory structure

    Create agent directory, and unzip agent distribution package to the directory.

    2. tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz -C agent
    3. cd agent
    4. tree 
    5. ├── LICENSE
    6. ├── NOTICE
    7. │   └── agent.yaml
    8. ├── plugins
    9. │   ├── lib
    10. │   │   ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
    11. │   │   └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
    12. │   ├── logging
    13. │   │   └── shardingsphere-agent-logging-file-${latest.release.version}.jar
    14. │   ├── metrics
    16. │   └── tracing
    17. │       ├── shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
    18. │       └── shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
    19. └── shardingsphere-agent-${latest.release.version}.jar

    Agent log output location is agent/logs/stdout.log.

    Plugin description

    File

    Currently, the File plugin only outputs the time-consuming log output of building metadata, and has no other log output for the time being.

    Prometheus

    Used for exposure monitoring metrics.

    • Parameter description

    OpenTelemetry

    OpenTelemetry can export tracing data to Jaeger, Zipkin.

    • Parameter description
    • Edit the startup script

    Configure the absolute path of shardingsphere-agent-${latest.release.version}.jar to the start.sh startup script of shardingsphere proxy.

    1. nohup java ${JAVA_OPTS} ${JAVA_MEM_OPTS} \
    2. -javaagent:/xxxxx/agent/shardingsphere-agent-${latest.release.version}.jar \
    • Start ShardingSphere-Proxy

    After startup, you can find the plugin info in the log of ShardingSphere-Proxy, Metric and Tracing data can be viewed through the configured monitoring address.

    Use via container environment

    • Assume that the following corresponding configurations have been completed locally.

      • Folder ./custom/agent/ that contains all files after unpacking ShardingSphere-Agent binary package
      • The folder containing the configuration files of ShardingSphere-Proxy such as server.yaml is ./custom/conf/
    • At this point, the use of ShardingSphere-Agent can be configured through the environment variable . Taking starting in the Docker Compose environment as an example, a reasonable docker-compose.yml example is as follows.
    1. version: "3.8"
    3. services:
    4.   apache-shardingsphere-proxy:
    5.     image: apache/shardingsphere-proxy:latest
    6.     environment:
    7.       JVM_OPTS: "-javaagent:/agent/shardingsphere-agent-${latest.release.version}.jar"
    8.       PORT: 3308
    9.     volumes:
    10.       - ./custom/agent:/agent/
    11.       - ./custom/conf:/opt/shardingsphere-proxy/conf/
    12.     ports:
    13.       - "13308:3308"