Add otlp exporters missing documentation (#4055)

open-telemetry · Jul 16, 2024 · b1e99c1 · b1e99c1
1 parent 2447868
commit b1e99c1
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 1 deletion.
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -9,8 +9,12 @@ sphinx-jekyll-builder==0.3.0
 ./opentelemetry-api
 ./opentelemetry-semantic-conventions
 ./opentelemetry-sdk
+./opentelemetry-proto
 ./shim/opentelemetry-opencensus-shim
 ./shim/opentelemetry-opentracing-shim
+./exporter/opentelemetry-exporter-otlp-proto-common
+./exporter/opentelemetry-exporter-otlp-proto-http
+./exporter/opentelemetry-exporter-otlp-proto-grpc
 
 # Required by instrumentation and exporter packages
 grpcio~=1.27

diff --git a/docs/conf.py b/docs/conf.py
@@ -115,6 +115,29 @@
         "py:class",
         "opentelemetry.trace._LinkBase",
     ),
+    (
+        "py:class",
+        "opentelemetry.exporter.otlp.proto.grpc.exporter.OTLPExporterMixin",
+    ),
+    (
+        "py:class",
+        "opentelemetry.proto.collector.trace.v1.trace_service_pb2.ExportTraceServiceRequest",
+    ),
+    (
+        "py:class",
+        "opentelemetry.exporter.otlp.proto.common._internal.metrics_encoder.OTLPMetricExporterMixin",
+    ),
+    ("py:class", "opentelemetry.proto.resource.v1.resource_pb2.Resource"),
+    (
+        "py:class",
+        "opentelemetry.proto.collector.metrics.v1.metrics_service_pb2.ExportMetricsServiceRequest",
+    ),
+    ("py:class", "opentelemetry.sdk._logs._internal.export.LogExporter"),
+    ("py:class", "opentelemetry.sdk._logs._internal.export.LogExportResult"),
+    (
+        "py:class",
+        "opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",
+    ),
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/exporter/otlp/otlp.rst b/docs/exporter/otlp/otlp.rst
@@ -1,12 +1,34 @@
 OpenTelemetry OTLP Exporters
 ============================
-
 .. automodule:: opentelemetry.exporter.otlp
     :members:
     :undoc-members:
     :show-inheritance:
 
+opentelemetry.exporter.otlp.proto.http
+---------------------------------------
+
+.. automodule:: opentelemetry.exporter.otlp.proto.http
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: opentelemetry.exporter.otlp.proto.http.trace_exporter
+
+.. automodule:: opentelemetry.exporter.otlp.proto.http.metric_exporter
+
+.. automodule:: opentelemetry.exporter.otlp.proto.http._log_exporter
+
+opentelemetry.exporter.otlp.proto.grpc
+---------------------------------------
+
 .. automodule:: opentelemetry.exporter.otlp.proto.grpc
     :members:
     :undoc-members:
     :show-inheritance:
+
+.. automodule:: opentelemetry.exporter.otlp.proto.grpc.trace_exporter
+
+.. automodule:: opentelemetry.exporter.otlp.proto.grpc.metric_exporter
+
+.. automodule:: opentelemetry.exporter.otlp.proto.grpc._log_exporter