Add boto3sqs to docs (#1666)

This commit is contained in:
Nimrod Shlagman
2023-02-20 18:21:13 +02:00
committed by GitHub
parent aa6397ad59
commit d5cbd67e88
5 changed files with 22 additions and 5 deletions

View File

@ -24,6 +24,7 @@ aiopg>=0.13.0,<1.3.0
asyncpg>=0.12.0 asyncpg>=0.12.0
boto~=2.0 boto~=2.0
botocore~=1.0 botocore~=1.0
boto3~=1.0
celery>=4.0 celery>=4.0
confluent-kafka>= 1.8.2,< 2.0.0 confluent-kafka>= 1.8.2,< 2.0.0
elasticsearch>=2.0,<9.0 elasticsearch>=2.0,<9.0

View File

@ -126,7 +126,7 @@ def getlistcfg(strval):
] ]
ignore_categories = ["py-class", "py-func", "py-exc", "any"] ignore_categories = ["py-class", "py-func", "py-exc", "py-obj", "any"]
for category in ignore_categories: for category in ignore_categories:
if category in mcfg: if category in mcfg:

View File

@ -0,0 +1,6 @@
.. include:: ../../../instrumentation/opentelemetry-instrumentation-boto3sqs/README.rst
.. automodule:: opentelemetry.instrumentation.boto3sqs
:members:
:undoc-members:
:show-inheritance:

View File

@ -13,6 +13,7 @@ py-class=
opentelemetry.sdk.trace.id_generator.IdGenerator opentelemetry.sdk.trace.id_generator.IdGenerator
opentelemetry.instrumentation.confluent_kafka.ProxiedProducer opentelemetry.instrumentation.confluent_kafka.ProxiedProducer
opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer
opentelemetry.instrumentation.instrumentor.BaseInstrumentor
; - AwsXRayIdGenerator ; - AwsXRayIdGenerator
TextMapPropagator TextMapPropagator
CarrierT CarrierT
@ -54,7 +55,16 @@ any=
; - instrumentation.* ; - instrumentation.*
Setter Setter
httpx httpx
; instrument
__iter__
list.__iter__
__getitem__
list.__getitem__
SQS.ReceiveMessage
py-obj=
opentelemetry.propagators.textmap.CarrierT
py-func= py-func=
poll poll
flush flush

View File

@ -16,17 +16,17 @@ Instrument `boto3sqs`_ to trace SQS applications.
.. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html .. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html
Usage Usage
----- -----
.. code:: python .. code-block:: python
import boto3 import boto3
from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor
Boto3SQSInstrumentor().instrument() Boto3SQSInstrumentor().instrument()
---
""" """
import logging import logging
from typing import Any, Collection, Dict, Generator, List, Mapping, Optional from typing import Any, Collection, Dict, Generator, List, Mapping, Optional