diff --git a/docs-requirements.txt b/docs-requirements.txt index 2d09dc0441..6d11d20198 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -24,6 +24,7 @@ aiopg>=0.13.0,<1.3.0 asyncpg>=0.12.0 boto~=2.0 botocore~=1.0 +boto3~=1.0 celery>=4.0 confluent-kafka>= 1.8.2,< 2.0.0 elasticsearch>=2.0,<9.0 diff --git a/docs/conf.py b/docs/conf.py index 7c628b7cd8..23918eb331 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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: if category in mcfg: diff --git a/docs/instrumentation/boto3sqs/boto3sqs.rst b/docs/instrumentation/boto3sqs/boto3sqs.rst new file mode 100644 index 0000000000..75bf46d2d1 --- /dev/null +++ b/docs/instrumentation/boto3sqs/boto3sqs.rst @@ -0,0 +1,6 @@ +.. include:: ../../../instrumentation/opentelemetry-instrumentation-boto3sqs/README.rst + +.. automodule:: opentelemetry.instrumentation.boto3sqs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nitpick-exceptions.ini b/docs/nitpick-exceptions.ini index 2b0910ad30..9dc379cf93 100644 --- a/docs/nitpick-exceptions.ini +++ b/docs/nitpick-exceptions.ini @@ -13,6 +13,7 @@ py-class= opentelemetry.sdk.trace.id_generator.IdGenerator opentelemetry.instrumentation.confluent_kafka.ProxiedProducer opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer + opentelemetry.instrumentation.instrumentor.BaseInstrumentor ; - AwsXRayIdGenerator TextMapPropagator CarrierT @@ -54,7 +55,16 @@ any= ; - instrumentation.* Setter httpx -; + instrument + __iter__ + list.__iter__ + __getitem__ + list.__getitem__ + SQS.ReceiveMessage + +py-obj= + opentelemetry.propagators.textmap.CarrierT + py-func= poll flush diff --git a/instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py b/instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py index dacb931db6..9f4ede9c35 100644 --- a/instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py @@ -16,17 +16,17 @@ .. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html - Usage ----- -.. code:: python +.. code-block:: python import boto3 from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor - Boto3SQSInstrumentor().instrument() + +--- """ import logging from typing import Any, Collection, Dict, Generator, List, Mapping, Optional