opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentati...
alrex 3e4c5d3aa3
[pre-release] Update changelogs, version [0.16b0] (#217)
2020-11-25 19:44:20 -08:00
..
src/opentelemetry/instrumentation/fastapi [pre-release] Update changelogs, version [0.16b0] (#217) 2020-11-25 19:44:20 -08:00
tests Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
CHANGELOG.md Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
README.rst Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
setup.cfg [pre-release] Update changelogs, version [0.16b0] (#217) 2020-11-25 19:44:20 -08:00
setup.py Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00

README.rst

OpenTelemetry FastAPI Instrumentation
=======================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-fastapi.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-fastapi/


This library provides automatic and manual instrumentation of FastAPI web frameworks,
instrumenting http requests served by applications utilizing the framework.

auto-instrumentation using the opentelemetry-instrumentation package is also supported.

Installation
------------

::

    pip install opentelemetry-instrumentation-fastapi


Usage
-----

.. code-block:: python

    import fastapi
    from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor

    app = fastapi.FastAPI()

    @app.get("/foobar")
    async def foobar():
        return {"message": "hello world"}

    FastAPIInstrumentor.instrument_app(app)


References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_