Files
Riccardo Magliocchetti 642d8c4081 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 <9735060+emdneto@users.noreply.github.com>

---------

Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>
2025-04-01 12:44:09 +00:00

63 lines
1.7 KiB
ReStructuredText

OpenTelemetry Botocore Tracing
==============================
|pypi|
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-botocore.svg
:target: https://pypi.org/project/opentelemetry-instrumentation-botocore/
This library allows tracing requests made by the Botocore library.
Extensions
----------
The instrumentation supports creating extensions for AWS services for enriching what is collected. We have extensions
for the following AWS services:
- Bedrock Runtime
- DynamoDB
- Lambda
- SNS
- SQS
Bedrock Runtime
***************
This extension implements the GenAI semantic conventions for the following API calls:
- Converse
- ConverseStream
- InvokeModel
- InvokeModelWithResponseStream
For the Converse and ConverseStream APIs tracing, events and metrics are implemented.
For the InvokeModel and InvokeModelWithResponseStream APIs tracing, events and metrics implemented only for a subset of
the available models, namely:
- Amazon Titan models
- Amazon Nova models
- Anthropic Claude
Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported with:
- Amazon Nova models
- Anthropic Claude 3+
If you don't have an application using Bedrock APIs yet, try our `zero-code examples <examples/bedrock-runtime/zero-code>`_.
Installation
------------
::
pip install opentelemetry-instrumentation-botocore
References
----------
* `OpenTelemetry Botocore Tracing <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/botocore/botocore.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_