api.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. Python API
  2. ==========
  3. Classes
  4. -------
  5. .. autoclass:: opentracing.Span
  6. :members:
  7. .. autoclass:: opentracing.SpanContext
  8. :members:
  9. .. autoclass:: opentracing.Scope
  10. :members:
  11. .. autoclass:: opentracing.ScopeManager
  12. :members:
  13. .. autoclass:: opentracing.Tracer
  14. :members:
  15. .. autoclass:: opentracing.ReferenceType
  16. :members:
  17. .. autoclass:: opentracing.Reference
  18. :members:
  19. .. autoclass:: opentracing.Format
  20. :members:
  21. Utility Functions
  22. -----------------
  23. .. autofunction:: opentracing.global_tracer
  24. .. autofunction:: opentracing.set_global_tracer
  25. .. autofunction:: opentracing.start_child_span
  26. .. autofunction:: opentracing.child_of
  27. .. autofunction:: opentracing.follows_from
  28. Exceptions
  29. ----------
  30. .. autoclass:: opentracing.InvalidCarrierException
  31. :members:
  32. .. autoclass:: opentracing.SpanContextCorruptedException
  33. :members:
  34. .. autoclass:: opentracing.UnsupportedFormatException
  35. :members:
  36. MockTracer
  37. --------------
  38. .. autoclass:: opentracing.mocktracer.MockTracer
  39. :members:
  40. Scope managers
  41. --------------
  42. .. autoclass:: opentracing.scope_managers.ThreadLocalScopeManager
  43. :members:
  44. .. autoclass:: opentracing.scope_managers.gevent.GeventScopeManager
  45. :members:
  46. .. autoclass:: opentracing.scope_managers.tornado.TornadoScopeManager
  47. :members:
  48. .. autofunction:: opentracing.scope_managers.tornado.tracer_stack_context
  49. .. autoclass:: opentracing.scope_managers.asyncio.AsyncioScopeManager
  50. :members: