mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-08-03 04:10:48 +08:00
Add confluent kafka docs (#1668)
* add elasticsearch to docs * add confluent kafka to docs * tox generate fix * tox docs fix --------- Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com>
This commit is contained in:
25
docs/conf.py
25
docs/conf.py
@ -126,25 +126,14 @@ def getlistcfg(strval):
|
||||
]
|
||||
|
||||
|
||||
if "class_references" in mcfg:
|
||||
class_references = getlistcfg(mcfg["class_references"])
|
||||
for class_reference in class_references:
|
||||
nitpick_ignore.append(
|
||||
(
|
||||
"py:class",
|
||||
class_reference,
|
||||
)
|
||||
)
|
||||
ignore_categories = ["py-class", "py-func", "py-exc", "any"]
|
||||
|
||||
for category in ignore_categories:
|
||||
if category in mcfg:
|
||||
items = getlistcfg(mcfg[category])
|
||||
for item in items:
|
||||
nitpick_ignore.append((category.replace("-", ":"), item))
|
||||
|
||||
if "anys" in mcfg:
|
||||
anys = getlistcfg(mcfg["anys"])
|
||||
for _any in anys:
|
||||
nitpick_ignore.append(
|
||||
(
|
||||
"any",
|
||||
_any,
|
||||
)
|
||||
)
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
7
docs/instrumentation/confluent_kafka/confluent_kafka.rst
Normal file
7
docs/instrumentation/confluent_kafka/confluent_kafka.rst
Normal file
@ -0,0 +1,7 @@
|
||||
.. include:: ../../../instrumentation/opentelemetry-instrumentation-confluent-kafka/README.rst
|
||||
|
||||
.. automodule:: opentelemetry.instrumentation.confluent_kafka
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:noindex:
|
@ -1,5 +1,5 @@
|
||||
[default]
|
||||
class_references=
|
||||
py-class=
|
||||
; TODO: Understand why sphinx is not able to find this local class
|
||||
opentelemetry.propagators.textmap.CarrierT
|
||||
opentelemetry.propagators.textmap.Setter
|
||||
@ -11,6 +11,8 @@ class_references=
|
||||
opentelemetry.propagators.textmap.Getter
|
||||
; - AWSXRayPropagator
|
||||
opentelemetry.sdk.trace.id_generator.IdGenerator
|
||||
opentelemetry.instrumentation.confluent_kafka.ProxiedProducer
|
||||
opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer
|
||||
; - AwsXRayIdGenerator
|
||||
TextMapPropagator
|
||||
CarrierT
|
||||
@ -26,8 +28,16 @@ class_references=
|
||||
httpx.AsyncByteStream
|
||||
httpx.Response
|
||||
yarl.URL
|
||||
cimpl.Producer
|
||||
cimpl.Consumer
|
||||
func
|
||||
Message
|
||||
TopicPartition
|
||||
callable
|
||||
Consumer
|
||||
confluent_kafka.Message
|
||||
|
||||
anys=
|
||||
any=
|
||||
; API
|
||||
opentelemetry.propagators.textmap.TextMapPropagator.fields
|
||||
; - AWSXRayPropagator
|
||||
@ -44,3 +54,12 @@ anys=
|
||||
; - instrumentation.*
|
||||
Setter
|
||||
httpx
|
||||
;
|
||||
py-func=
|
||||
poll
|
||||
flush
|
||||
Message.error
|
||||
|
||||
py-exc=
|
||||
KafkaException
|
||||
KafkaError
|
||||
|
Reference in New Issue
Block a user