Add some docs and rename mode to exporter

README.md

@@ -55,21 +55,18 @@ Join our [slack channel](https://join.slack.com/t/hitsz-ids/shared_invite/zt-239
 - `Tracer` Support
   - [X] eBPF-based tracer
   - [X] Shell command tracer
-  - [ ] Subprocess tracer
+  - [X] Subprocess tracer
 - `Filter` Support
   - [X] Pattern matching, based on regular expressions
-- `Collector` and `Analyzer` Support
-  - [X] SQL database
-  - [ ] OpenTelemetry
-- Analyzer Support
-  - [X] SQL database
-  - [ ] OpenTelemetry
+- Data Collection and Analysis
+  - [X] `Analyzer` Support SQL database
+  - [X] `Collector` Support SQL database and *OpenTelemetry(Experimental)*
 - User Interface
   - [X] CLI Tools
   - [X] PIP Service
   - [ ] Control Panel
 - Enhancements
-  - [ ] Runc containers identification
+  - [ ] `RunC` containers identification
 
 The eBPF program requires kernel support, see [Kernel Support](./docs/kernel_config.md)
 

README_zh.md

@@ -59,16 +59,18 @@ duetector🔍是一个基于可扩展的的数据使用探测器，它可以在L
 - `Tracer`支持
   - [X] 基于eBPF的tracer
   - [X] 基于shell命令的tracer
-  - [ ] 基于子进程的tracer
+  - [X] 基于子进程的tracer
 - `Filter`支持
   - [X] 支持正则的模式匹配
-- `Collector`和`Analyzer`支持
-  - [X] SQL数据库
-  - [ ] Opentelemetry
+- 遥测数据传输与分析
+  - [X] `Analyzer`支持SQL数据库
+  - [X] `Collector`支持SQL数据库和*Opentelemetry（实验性）*
 - 用户接口
   - [X] 命令行工具
   - [X] PIP服务
   - [ ] 控制平面
+- 增强功能
+  - [ ] `RunC`容器云原生支持
 
 eBPF程序需要内核支持，详见[内核支持](./docs/kernel_config.md)
 

duetector/collectors/otel.py

@@ -25,6 +25,37 @@
 
 
 class OTelInitiator:
+    """
+    Host the OpenTelemetry SDK and initialize the provider and exporter.
+
+    Avaliable exporters:
+        - ``console``
+        - ``otlp-grpc``
+        - ``otlp-http``
+        - ``jaeger-thrift``
+        - ``jaeger-grpc``
+        - ``zipkin-http``
+        - ``zipkin-json``
+        - ``prometheus``
+
+    Example:
+
+    .. code-block:: python
+
+            otel = OTelInitiator()
+            trace = otel.initialize(
+                service_name="duetector",
+                exporter="console",
+            )
+
+            from opentelemetry import trace
+            tracer = trace.get_tracer(__name__)
+            with tracer.start_as_current_span("test") as span:
+                span.set_attribute("test", "test")
+
+            otel.shutdown()
+    """
+
     exporter_cls = {
         "console": ConsoleSpanExporter,
         "otlp-grpc": GRPCOTLPSpanExporter,
@@ -76,16 +107,28 @@ def shutdown(self):
 
 
 class OTelCollector(Collector):
+    """
+    A collector using OpenTelemetry SDK.
+
+    Config:
+        - ``exporter``: One of ``console``, ``otlp-grpc``, ``otlp-http``, ``jaeger-thrift``, ``jaeger-grpc``, ``zipkin-http``, ``zipkin-json``, see :class:`OTelInitiator` for more details
+        - ``exporter_kwargs``: A dict of kwargs for exporter
+
+    Note:
+        Since v1.35, the Jaeger supports OTLP natively. Please use the OTLP exporter instead. Support for this exporter will end July 2023.
+
+    """
+
     default_config = {
         **Collector.default_config,
         "disabled": True,
-        "mode": "console",
+        "exporter": "console",
         "exporter_kwargs": {},
     }
 
     @property
-    def mode(self) -> str:
-        return self.config.mode
+    def exporter(self) -> str:
+        return self.config.exporter
 
     @property
     def endpoint(self) -> Optional[str]:
@@ -100,7 +143,7 @@ def __init__(self, config: Optional[Dict[str, Any]] = None, *args, **kwargs):
         self.otel = OTelInitiator()
         self.otel.initialize(
             service_name="duetector",
-            exporter=self.mode,
+            exporter=self.exporter,
             exporter_kwargs=self.exporter_kwargs,
         )
 

duetector/static/config.toml

@@ -66,7 +66,7 @@ include_extension = true
 [collector.otelcollector]
 disabled = true
 statis_id = ""
-mode = "console"
+exporter = "console"
 
 [collector.otelcollector.backend_args]
 max_workers = 10

tests/config.toml

@@ -58,7 +58,7 @@ include_extension = true
 [collector.otelcollector]
 disabled = false
 statis_id = ""
-mode = "console"
+exporter = "console"
 
 [collector.otelcollector.backend_args]
 max_workers = 10