Agent Integration

Background

ShardingSphere-Agent is an independent and independently designed project based on ByteBuddy bytecode increase. Based on plugin design, it can integrate seamlessly with ShardingSphere. There are currently Log, metrics, APM and other observability capabilities available.

Usage

Local build

  1.  > cd  shardingsphere/shardingsphere-agent
  2.  > mvn clean install

Remote download（No release）

  1.  > weget http://xxxxx/shardingsphere-agent.tar.gz
  2.  > tar -zxvcf shardingsphere-agent.tar.gz

Add startup arguments

  1. -javaagent:\absolute path\shardingsphere-agent.jar

Agent Configuration

It is found under the local package directory and unzip directory : agent.yaml

  1. applicationName: shardingsphere-agent # application name 
  2. ignoredPluginNames: # A collection of ignored plugins, indicating that the plugins in the collection are not active
  3.   - Opentracing
  4.   - Jaeger
  5.   - Zipkin
  6.   - Prometheus
  7.   - OpenTelemetry
  8.   - Logging
  10. plugins:
  11.   Prometheus:
  12.     host:  "localhost" #prometheus host
  13.     port: 9090 #prometheus port 
  14.     props:
  15.       JVM_INFORMATION_COLLECTOR_ENABLED : "true"
  16.   Jaeger:
  17.     host: "localhost" #jaeger host
  18.     port: 5775 #jaeger prot
  19.     props:
  20.       SERVICE_NAME: "shardingsphere-agent"
  21.       JAEGER_SAMPLER_TYPE: "const"
  22.       JAEGER_SAMPLER_PARAM: "1"
  23.       JAEGER_REPORTER_LOG_SPANS: "true"
  24.       JAEGER_REPORTER_FLUSH_INTERVAL: "1"
  25.   Zipkin:
  26.     host: "localhost" #zipkin host
  27.     port: 9411 #zipkin prot
  28.     props:
  29.       SERVICE_NAME: "shardingsphere-agent"
  30.       URL_VERSION: "/api/v2/spans" #zipkin uri
  31.   Opentracing:
  32.     props:
  33.       OPENTRACING_TRACER_CLASS_NAME: "org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer"
  34.   OpenTelemetry:
  35.     props:
  36.       otel.resource.attributes: "service.name=shardingsphere-agent" #Resource information of opentelemetry, multiple configurations can be separated by ','
  37.       otel.traces.exporter: "zipkin" #the exporter of traces
  38.   Logging:
  39.     props:
  40.       LEVEL: "INFO" #log level

When ignoredPluginNames is configured, plugins in the collection are ignored!