Skip to content

Commit 642d8c4

Browse files
xrmxemdneto
andauthored
botocore: add some more content to the README (#3395)
* botocore: add some more content to the README This is taken from __init__.py documentation. * Move the content to the README since it's not really code specific * Add link to examples * Apply suggestions from code review Co-authored-by: Emídio Neto <[email protected]> --------- Co-authored-by: Emídio Neto <[email protected]>
1 parent 27d5d93 commit 642d8c4

File tree

2 files changed

+38
-34
lines changed
  • instrumentation/opentelemetry-instrumentation-botocore

2 files changed

+38
-34
lines changed

instrumentation/opentelemetry-instrumentation-botocore/README.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,44 @@ OpenTelemetry Botocore Tracing
88

99
This library allows tracing requests made by the Botocore library.
1010

11+
Extensions
12+
----------
13+
14+
The instrumentation supports creating extensions for AWS services for enriching what is collected. We have extensions
15+
for the following AWS services:
16+
17+
- Bedrock Runtime
18+
- DynamoDB
19+
- Lambda
20+
- SNS
21+
- SQS
22+
23+
Bedrock Runtime
24+
***************
25+
26+
This extension implements the GenAI semantic conventions for the following API calls:
27+
28+
- Converse
29+
- ConverseStream
30+
- InvokeModel
31+
- InvokeModelWithResponseStream
32+
33+
For the Converse and ConverseStream APIs tracing, events and metrics are implemented.
34+
35+
For the InvokeModel and InvokeModelWithResponseStream APIs tracing, events and metrics implemented only for a subset of
36+
the available models, namely:
37+
38+
- Amazon Titan models
39+
- Amazon Nova models
40+
- Anthropic Claude
41+
42+
Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported with:
43+
44+
- Amazon Nova models
45+
- Anthropic Claude 3+
46+
47+
If you don't have an application using Bedrock APIs yet, try our `zero-code examples <examples/bedrock-runtime/zero-code>`_.
48+
1149
Installation
1250
------------
1351

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

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -78,40 +78,6 @@ def response_hook(span, service_name, operation_name, result):
7878
)
7979
ec2 = session.create_client("ec2", region_name="us-west-2")
8080
ec2.describe_instances()
81-
82-
Extensions
83-
----------
84-
85-
The instrumentation supports creating extensions for AWS services for enriching what is collected. We have extensions
86-
for the following AWS services:
87-
88-
- Bedrock Runtime
89-
- DynamoDB
90-
- Lambda
91-
- SNS
92-
- SQS
93-
94-
Bedrock Runtime
95-
***************
96-
97-
This extension implements the GenAI semantic conventions for the following API calls:
98-
99-
- Converse
100-
- ConverseStream
101-
- InvokeModel
102-
- InvokeModelWithResponseStream
103-
104-
For the Converse and ConverseStream APIs tracing, events and metrics are implemented.
105-
106-
For the InvokeModel and InvokeModelWithResponseStream APIs tracing, events and metrics implemented only for a subset of
107-
the available models, namely:
108-
- Amazon Titan models
109-
- Amazon Nova models
110-
- Anthropic Claude
111-
112-
Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported with:
113-
- Amazon Nova models
114-
- Anthropic Claude 3+
11581
"""
11682

11783
import logging

0 commit comments

Comments
 (0)