signalfx-tracing 0.0.12.1

用于python的signalfx跟踪库：一个opentracing自动检测工具

此实用程序为用户提供自动配置 与OpenTracing 2.0兼容的社区贡献了工具库 对于他们的Python2.7和3.4+应用程序，只需一个函数。

fromsignalfx_tracingimportauto_instrument,create_tracertracer=create_tracer(service_name='MyService')auto_instrument(tracer)

如果不需要自动检测所有适用的库和框架， 通过指定目标模块可以单独启用检测：

fromsignalfx_tracingimportcreate_tracer,instrument,uninstrumenttracer=create_tracer()instrument(tracer,flask=True)# orinstrument(flask=True)# uses the global Tracer from opentracing.tracer by defaultimportflasktraced_app=flask.Flask('MyTracedApplication')@traced_app.route('/hello_world')deftraced_route():# Obtain active span created by traced middlewarespan=tracer.scope_manager.active.spanspan.set_tag('Hello','World')span.log_kv({'event':'initiated'})return'Hello!'# Span is automatically finished after request handleruninstrument('flask')# prevent future registrationsuntraced_app=flask.Flask('MyUntracedApplication')@untraced_app.route('/untraced_hello_world')defuntraced_route():return'Goodbye!'

注意：如果 signalfx_tracing_enabled环境变量设置为false或0。在开发 在本地或测试环境中自动检测应用程序。

支持的框架和库

• django 1.8+-仪器（django=true）
• elasticsearch 2.0+-仪器（elasticsearch=true）
• 烧瓶0.10+-仪器（烧瓶=真）
• psycopg 2.7+-仪器（psycopg2=true）
• pymongo 3.1+-仪器（pymongo=true）
• pymysql 0.8+-仪器（pymysql=true）
• redis py 2.10-仪器（redis=true）
• 请求2.0+-仪器（请求=真）
• tornado 4.3+-仪器（tornado=true）

安装和配置

库和仪器

用于python的signalfx跟踪库通过检测库和框架并配置可用的 用于通过python进行分布式跟踪的工具opentracing api 2.0。 默认情况下，它的内存占用很小，不将任何工具声明为依赖项。也就是说，它在 假设您根据需要安装了2.0兼容的检测工具。由于此api的采用是在 根据仪器，强烈建议您使用有用的引导实用程序 获取并安装任何适用的、功能齐全的仪表以及兼容的跟踪器：

  $ pip install signalfx-tracing
  $ sfx-py-trace-bootstrap

例如，如果您的环境在其python路径中有请求和flask，则相应的opentracing 仪表将安装PIP。同样，由于opentracing contrib instrumentation对api 2.0的支持不是 无处不在，此引导程序有选择地安装 仪器要求文件。因此，我们建议一定要卸载以前的 在运行引导程序之前，最好是在干净的环境中安装仪器。

若要在不安装建议的跟踪程序的情况下运行Instrumentor引导进程，可以从中运行以下命令 项目的源代码树：

  $ scripts/bootstrap.py --deps-only

您还可以指定一个目标安装目录，其中包括提供的最新的signalfx跟踪 PYPI：

  $ sfx-py-trace-bootstrap -t /my/site/packages/directory

也可以将受支持的检测程序作为克隆存储库：

  $ git clone https://github.com/signalfx/signalfx-python-tracing.git
  # Supported extras are dbapi, django, flask, pymongo, pymysql, redis, requests, tornado
  $ pip install './signalfx-python-tracing[django,redis,requests]'

注意：对于低于18.0的pip版本，必须包含--流程依赖关系链接 获得所需的乐器版本。

  $ git clone https://github.com/signalfx/signalfx-python-tracing.git
  # pip versions <18.0
  $ pip install --process-dependency-links './signalfx-python-tracing[jaeger,tornado]'

示踪剂

并非所有与opentracing兼容的跟踪程序的稳定版本都支持2.0api，因此我们提供 并建议安装一个修改过的jaeger客户端 准备向SignalFX报告。您可以使用 signalfx_tracing.utils.create_tracer（）帮助程序，前提是您已经运行了：

  $ sfx-py-trace-bootstrap

  # or as package extra
  $ pip install './signalfx-python-tracing[jaeger]'# please use required --process-dependency-links for pip versions <18.0 
  $ pip install --process-dependency-links './signalfx-python-tracing[jaeger]'# or from project source tree, along with applicable instrumentors
  $ scripts/bootstrap.py --jaeger

  # or to avoid applicable instrumentors
  $ scripts/bootstrap.py --jaeger-only

默认情况下，create_tracer（）将启用具有恒定采样（100%跟踪机会）的跟踪，并报告每个范围 直接发送到SignalFX。如果适用，上下文传播将通过 b3头

fromsignalfx_tracingimportcreate_tracer# sets the global opentracing.tracer by default:tracer=create_tracer()# uses 'SIGNALFX_ACCESS_TOKEN' environment variable if provided# or directly provide your organization access token if not using the Smart Agent to analyze spans:tracer=create_tracer('<OrganizationAccessToken>',...)# or to disable setting the global tracer:tracer=create_tracer(set_global=False)

所有其他create_tracer（）参数都是可以传递给jaeger_client.config构造函数的参数：

fromsignalfx_tracingimportauto_instrument,create_tracertracer=create_tracer(service_name='MyService')auto_instrument(tracer)

fromsignalfx_tracingimportauto_instrument,create_tracertracer=create_tracer(service_name='MyService')auto_instrument(tracer)

fromsignalfx_tracingimportauto_instrument,create_tracertracer=create_tracer(service_name='MyService')auto_instrument(tracer)