From b1e99c1555721f818e578d7457587693e767e182 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Em=C3=ADdio=20Neto?= <9735060+emdneto@users.noreply.github.com> Date: Tue, 16 Jul 2024 18:46:42 -0300 Subject: [PATCH] Add otlp exporters missing documentation (#4055) --- docs-requirements.txt | 4 ++++ docs/conf.py | 23 +++++++++++++++++++++++ docs/exporter/otlp/otlp.rst | 24 +++++++++++++++++++++++- 3 files changed, 50 insertions(+), 1 deletion(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 983fcddd8a4..799a10cb8e8 100644 --- 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 index 352cf927cd4..3aa7e022e3a 100644 --- 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 index 471f2935fb7..18b8b157340 100644 --- 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