Skip to content

Commit d5cbd67

Browse files
authored
Add boto3sqs to docs (open-telemetry#1666)
1 parent aa6397a commit d5cbd67

File tree

5 files changed

+22
-5
lines changed

5 files changed

+22
-5
lines changed

docs-requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ aiopg>=0.13.0,<1.3.0
2424
asyncpg>=0.12.0
2525
boto~=2.0
2626
botocore~=1.0
27+
boto3~=1.0
2728
celery>=4.0
2829
confluent-kafka>= 1.8.2,< 2.0.0
2930
elasticsearch>=2.0,<9.0

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def getlistcfg(strval):
126126
]
127127

128128

129-
ignore_categories = ["py-class", "py-func", "py-exc", "any"]
129+
ignore_categories = ["py-class", "py-func", "py-exc", "py-obj", "any"]
130130

131131
for category in ignore_categories:
132132
if category in mcfg:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. include:: ../../../instrumentation/opentelemetry-instrumentation-boto3sqs/README.rst
2+
3+
.. automodule:: opentelemetry.instrumentation.boto3sqs
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:

docs/nitpick-exceptions.ini

+11-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ py-class=
1313
opentelemetry.sdk.trace.id_generator.IdGenerator
1414
opentelemetry.instrumentation.confluent_kafka.ProxiedProducer
1515
opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer
16+
opentelemetry.instrumentation.instrumentor.BaseInstrumentor
1617
; - AwsXRayIdGenerator
1718
TextMapPropagator
1819
CarrierT
@@ -54,7 +55,16 @@ any=
5455
; - instrumentation.*
5556
Setter
5657
httpx
57-
;
58+
instrument
59+
__iter__
60+
list.__iter__
61+
__getitem__
62+
list.__getitem__
63+
SQS.ReceiveMessage
64+
65+
py-obj=
66+
opentelemetry.propagators.textmap.CarrierT
67+
5868
py-func=
5969
poll
6070
flush

instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@
1616
1717
.. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html
1818
19-
2019
Usage
2120
-----
2221
23-
.. code:: python
22+
.. code-block:: python
2423
2524
import boto3
2625
from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor
2726
28-
2927
Boto3SQSInstrumentor().instrument()
28+
29+
---
3030
"""
3131
import logging
3232
from typing import Any, Collection, Dict, Generator, List, Mapping, Optional

0 commit comments

Comments
 (0)