Logo
可观察性

可观察性 #

SphereEx-DBPlusEngine 已内置可观察性插件 SphereEx-Agent，为用户提供扩展日志、监控指标及链路追踪等多种功能。

Agent 配置 #

目录说明 #

Agent 相关文件位于 sphereex-dbplusengine-proxy/sphereex-agent 目录中

.
├── conf
│   └── agent.yaml
├── lib
│   ├── ...
├── plugins
│   ├── ...
├── template
│   └── dbplusengine-grafana-template.json
└── tool
    └── ...

配置说明 #

  • conf/agent.yaml 用于管理 Agent 配置。
  • 内置插件包括 Jaeger、OpenTracing、Zipkin、OpenTelemetry、BaseLogging 及 Prometheus。
  • BaseLogging 插件默认启用，并开启慢查询日志功能。

agent.yaml 默认配置内容如下：

plugins:
  logging:
    BaseLogging:
      props:
        slow-query-log: true
        long-query-time: 5000
        general-query-log: false
#  metrics:
#    Prometheus:
#      host: "0.0.0.0"
#      port: 9090
#      props:
#        jvm-information-collector-enabled: "true"
#  tracing:
#    Jaeger:
#      host: "localhost"
#      port: 5775
#      props:
#        service-name: "dbplusengine"
#        jaeger-sampler-type: "const"
#        jaeger-sampler-param: "1"
#    Zipkin:
#      host: "localhost"
#      port: 9411
#      props:
#        service-name: "dbplusengine"
#        url-version: "/api/v2/spans"
#        sampler-type: "const"
#        sampler-param: "1"
#    SkyWalking:
#      props:
#        opentracing-tracer-class-name: "org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer"
#    OpenTelemetry:
#      props:
#        otel-resource-attributes: "service.name=dbplusengine"
#        otel-traces-exporter: "zipkin"

参数说明 #

名称说明取值范围默认值
jvm-information-collector-enabled是否开启 JVM 采集器true、falsetrue
service-name链路跟踪的服务名称自定义dbplusengine
jaeger-sampler-typeJaeger 采样率类型const、probabilistic、ratelimiting、remoteconst
jaeger-sampler-paramJaeger 采样率参数const：0、1，probabilistic：0.0 - 1.0，ratelimiting：> 0，自定义每秒采集数量，remote：需要自定义配置远程采样率管理服务地址，JAEGER_SAMPLER_MANAGER_HOST_PORT1（const 类型）
url-versionZipkin url 地址自定义/api/v2/spans
sampler-typeZipkin 采样率类型const、counting、ratelimiting、boundaryconst
sampler-paramZipkin 采样率参数const： 0、1，counting：0.01 - 1.0，ratelimiting：> 0，自定义每秒采集数量，boundary: 0.0001 - 1.01（const 类型）
otel-resource-attributesopentelemetry 资源属性字符串键值对（,分割）service.name=dbplusengine-agent
otel-traces-exporterTracing expoterzipkin、jaegerzipkin
otel-traces-sampleropentelemetry 采样率类型always_on、always_off、traceidratioalways_on
otel-traces-sampler-argopentelemetry 采样率参数traceidratio：0.0 - 1.01.0

在 DBPlusEngine-Proxy 中使用 #

在 sphereex-dbplusengine-proxy/bin/ 目录下，为用户提供了两个启动脚本：

  • start.sh
  • start-with-agent.sh

当用户需要 Agent 功能时，请通过 start-with-agent.sh 启动 DBPlusEngine-Proxy。

bin/start-with-agent.sh

启动成功后，可在 DBPlusEngine-Proxy 日志中找到 plugin 的加载信息。 若开启了 metrics 或 tracing 配置，则在访问 Proxy 后，可以通过配置的监控地址查看到相关数据。