Skip to content

Commit

Permalink
Update agent and config document for dev-manual (apache#19238)
Browse files Browse the repository at this point in the history
* Update agent document

* Update config document

* Update agent document

* Update config document

* Update agent document

* Update config document
  • Loading branch information
terrymanu authored Jul 15, 2022
1 parent 3886f2d commit 3403c70
Show file tree
Hide file tree
Showing 4 changed files with 223 additions and 162 deletions.
71 changes: 41 additions & 30 deletions docs/document/content/dev-manual/agent.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,44 @@ weight = 14
chapter = true
+++

## SPI 接口

| *SPI 名称* | *详细说明* |
|---------------- |------------ |
| PluginDefinitionService | Agent 插件定义 |
| PluginBootService | 插件启动服务定义 |

## 示例
### PluginDefinitionService

| *已知实现类* | *详细说明* |
|-------------------------------- |----------------------- |
| PrometheusPluginDefinitionService | Prometheus plugin |
| BaseLoggingPluginDefinitionService | Logging plugin |
| JaegerPluginDefinitionService | Jaeger plugin |
| OpenTelemetryTracingPluginDefinitionService | OpenTelemetryTracing plugin |
| OpenTracingPluginDefinitionService | OpenTracing plugin |
| ZipkinPluginDefinitionService | Zipkin plugin |


### PluginBootService

| *已知实现类* | *详细说明* |
|-------------------------------- |----------------------- |
| PrometheusPluginBootService | Prometheus plugin 启动类 |
| BaseLoggingPluginBootService | Logging plugin 启动类 |
| JaegerTracingPluginBootService | Jaeger plugin 启动类 |
| OpenTelemetryTracingPluginBootService | OpenTelemetryTracing plugin 启动类 |
| OpenTracingPluginBootService | OpenTracing plugin 启动类 |
| ZipkinTracingPluginBootService | Zipkin plugin 启动类 |
## PluginBootService

### 全限定类名

[`org.apache.shardingsphere.agent.spi.boot.PluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/boot/PluginBootService.java)

### 定义

插件启动服务定义接口

### 已知实现

| *配置标识* | *详细说明* | *全限定类名* |
| ------------- | --------------------------------- | ---------- |
| Prometheus | Prometheus plugin 启动类 | [`org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/service/PrometheusPluginBootService.java) |
| Logging | Logging plugin 启动类 | [`org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/service/BaseLoggingPluginBootService.java) |
| Jaeger | Jaeger plugin 启动类 | [`org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java) |
| OpenTelemetry | OpenTelemetryTracing plugin 启动类 | [`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/service/OpenTelemetryTracingPluginBootService.java) |
| OpenTracing | OpenTracing plugin 启动类 | [`org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/service/OpenTracingPluginBootService.java) |
| Zipkin | Zipkin plugin 启动类 | [`org.apache.shardingsphere.agent.plugin.tracing.zipkin.service.ZipkinTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java) |

## PluginDefinitionService

### 全限定类名

[`org.apache.shardingsphere.agent.spi.definition.PluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/definition/PluginDefinitionService.java)

### 定义

探针插件定义服务接口

### 已知实现

| *配置标识* | *详细说明* | *全限定类名* |
| ------------- | --------------------------- | ---------- |
| Prometheus | Prometheus 插件定义 | [`org.apache.shardingsphere.agent.metrics.prometheus.definition.PrometheusPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/definition/PrometheusPluginDefinitionService.java) |
| Logging | Logging 插件定义 | [`org.apache.shardingsphere.agent.plugin.logging.base.definition.BaseLoggingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/definition/BaseLoggingPluginDefinitionService.java) |
| Jaeger | Jaeger 插件定义 | [`org.apache.shardingsphere.agent.plugin.tracing.jaeger.definition.JaegerPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/definition/JaegerPluginDefinitionService.java) |
| OpenTelemetry | OpenTelemetryTracing 插件定义 | [`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.definition.OpenTelemetryTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/definition/OpenTelemetryTracingPluginDefinitionService.java) |
| OpenTracing | OpenTracing 插件定义 | [`org.apache.shardingsphere.agent.plugin.tracing.opentracing.definition.OpenTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/definition/OpenTracingPluginDefinitionService.java) |
| Zipkin | Zipkin 插件定义 | [`org.apache.shardingsphere.agent.plugin.tracing.zipkin.definition.ZipkinPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/definition/ZipkinPluginDefinitionService.java) |
58 changes: 34 additions & 24 deletions docs/document/content/dev-manual/agent.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,44 @@ weight = 14
chapter = true
+++

## SPI Interface
## PluginBootService

| *SPI Name* | *Description* |
|---------------- |------------ |
| PluginDefinitionService | Agent plugin definition |
| PluginBootService | Plugin startup service definition |
### Fully-qualified class name

## Sample
### PluginDefinitionService
[`org.apache.shardingsphere.agent.spi.boot.PluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/boot/PluginBootService.java)

| *Implementation Class* | *Description* |
|-------------------------------- |----------------------- |
| PrometheusPluginDefinitionService | Prometheus plugin |
| BaseLoggingPluginDefinitionService | Logging plugin |
| JaegerPluginDefinitionService | Jaeger plugin |
| OpenTelemetryTracingPluginDefinitionService | OpenTelemetryTracing plugin |
| OpenTracingPluginDefinitionService | OpenTracing plugin |
| ZipkinPluginDefinitionService | Zipkin plugin |
### Definition

Plugin startup service definition

### PluginBootService
### Implementation classes

| *Configuration Type* | *Description* | *Fully-qualified class name* |
| -------------------- | ----------------------------------------- | ---------------------------- |
| Prometheus | Prometheus plugin startup class | [`org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/service/PrometheusPluginBootService.java) |
| Logging | Logging plugin startup class | [`org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/service/BaseLoggingPluginBootService.java) |
| Jaeger | Jaeger plugin startup class | [`org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java) |
| OpenTelemetry | OpenTelemetryTracing plugin startup class | [`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/service/OpenTelemetryTracingPluginBootService.java) |
| OpenTracing | OpenTracing plugin startup class | [`org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/service/OpenTracingPluginBootService.java) |
| Zipkin | Zipkin plugin startup class | [`org.apache.shardingsphere.agent.plugin.tracing.zipkin.service.ZipkinTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java) |

| *Implementation Class* | *Description* |
|-------------------------------- |---------------- |
| PrometheusPluginBootService | Prometheus plugin startup class |
| BaseLoggingPluginBootService | Logging plugin startup class |
| JaegerTracingPluginBootService | Jaeger plugin startup class |
| OpenTelemetryTracingPluginBootService | OpenTelemetryTracing plugin startup class |
| OpenTracingPluginBootService | OpenTracing plugin startup class |
| ZipkinTracingPluginBootService | Zipkin plugin startup class |
## PluginDefinitionService

### Fully-qualified class name

[`org.apache.shardingsphere.agent.spi.definition.PluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/definition/PluginDefinitionService.java)

### Definition

Agent plugin definition

### Implementation classes

| *Configuration Type* | *Description* | *Fully-qualified class name* |
| -------------------- |--------------------------------------- | ---------------------------- |
| Prometheus | Prometheus plugin definition | [`org.apache.shardingsphere.agent.metrics.prometheus.definition.PrometheusPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/definition/PrometheusPluginDefinitionService.java) |
| Logging | Logging plugin definition | [`org.apache.shardingsphere.agent.plugin.logging.base.definition.BaseLoggingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/definition/BaseLoggingPluginDefinitionService.java) |
| Jaeger | Jaeger plugin definition | [`org.apache.shardingsphere.agent.plugin.tracing.jaeger.definition.JaegerPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/definition/JaegerPluginDefinitionService.java) |
| OpenTelemetry | OpenTelemetryTracing plugin definition | [`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.definition.OpenTelemetryTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/definition/OpenTelemetryTracingPluginDefinitionService.java) |
| OpenTracing | OpenTracing plugin definition | [`org.apache.shardingsphere.agent.plugin.tracing.opentracing.definition.OpenTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/definition/OpenTracingPluginDefinitionService.java) |
| Zipkin | Zipkin plugin definition | [`org.apache.shardingsphere.agent.plugin.tracing.zipkin.definition.ZipkinPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/definition/ZipkinPluginDefinitionService.java) |
Loading

0 comments on commit 3403c70

Please sign in to comment.