Skip to content

Commit b1e99c1

Browse files
authored
Add otlp exporters missing documentation (#4055)
1 parent 2447868 commit b1e99c1

File tree

3 files changed

+50
-1
lines changed

3 files changed

+50
-1
lines changed

docs-requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@ sphinx-jekyll-builder==0.3.0
99
./opentelemetry-api
1010
./opentelemetry-semantic-conventions
1111
./opentelemetry-sdk
12+
./opentelemetry-proto
1213
./shim/opentelemetry-opencensus-shim
1314
./shim/opentelemetry-opentracing-shim
15+
./exporter/opentelemetry-exporter-otlp-proto-common
16+
./exporter/opentelemetry-exporter-otlp-proto-http
17+
./exporter/opentelemetry-exporter-otlp-proto-grpc
1418

1519
# Required by instrumentation and exporter packages
1620
grpcio~=1.27

docs/conf.py

+23
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,29 @@
115115
"py:class",
116116
"opentelemetry.trace._LinkBase",
117117
),
118+
(
119+
"py:class",
120+
"opentelemetry.exporter.otlp.proto.grpc.exporter.OTLPExporterMixin",
121+
),
122+
(
123+
"py:class",
124+
"opentelemetry.proto.collector.trace.v1.trace_service_pb2.ExportTraceServiceRequest",
125+
),
126+
(
127+
"py:class",
128+
"opentelemetry.exporter.otlp.proto.common._internal.metrics_encoder.OTLPMetricExporterMixin",
129+
),
130+
("py:class", "opentelemetry.proto.resource.v1.resource_pb2.Resource"),
131+
(
132+
"py:class",
133+
"opentelemetry.proto.collector.metrics.v1.metrics_service_pb2.ExportMetricsServiceRequest",
134+
),
135+
("py:class", "opentelemetry.sdk._logs._internal.export.LogExporter"),
136+
("py:class", "opentelemetry.sdk._logs._internal.export.LogExportResult"),
137+
(
138+
"py:class",
139+
"opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",
140+
),
118141
]
119142

120143
# Add any paths that contain templates here, relative to this directory.

docs/exporter/otlp/otlp.rst

+23-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,34 @@
11
OpenTelemetry OTLP Exporters
22
============================
3-
43
.. automodule:: opentelemetry.exporter.otlp
54
:members:
65
:undoc-members:
76
:show-inheritance:
87

8+
opentelemetry.exporter.otlp.proto.http
9+
---------------------------------------
10+
11+
.. automodule:: opentelemetry.exporter.otlp.proto.http
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
.. automodule:: opentelemetry.exporter.otlp.proto.http.trace_exporter
17+
18+
.. automodule:: opentelemetry.exporter.otlp.proto.http.metric_exporter
19+
20+
.. automodule:: opentelemetry.exporter.otlp.proto.http._log_exporter
21+
22+
opentelemetry.exporter.otlp.proto.grpc
23+
---------------------------------------
24+
925
.. automodule:: opentelemetry.exporter.otlp.proto.grpc
1026
:members:
1127
:undoc-members:
1228
:show-inheritance:
29+
30+
.. automodule:: opentelemetry.exporter.otlp.proto.grpc.trace_exporter
31+
32+
.. automodule:: opentelemetry.exporter.otlp.proto.grpc.metric_exporter
33+
34+
.. automodule:: opentelemetry.exporter.otlp.proto.grpc._log_exporter

0 commit comments

Comments
 (0)