配置 Python 收集器

瓶 WSGI

使用以下命令对 Bottle WSGI 进行检测：

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

from bottle import Bottle, run

app = Bottle()

@app.route('/hello')
def hello():
    return "Hello World!"

# Wrap the application with the Instana WSGI Middleware
app = InstanaWSGIMiddleware(app)

# Alternative method for reference
# app = InstanaWSGIMiddleware(bottle.default_app())

run(app, host='localhost', port=8080)

CherryPy WSGI

使用以下命令对 CherryPy WSGI 进行检测：

import cherrypy

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

# My CherryPy application
class Root(object):
    @cherrypy.expose
    def index(self):
        return "hello world"

cherrypy.config.update({'engine.autoreload.on': False})
cherrypy.server.unsubscribe()
cherrypy.engine.start()

# Wrap the application with the Instana WSGI Middleware
wsgiapp = InstanaWSGIMiddleware(cherrypy.tree.mount(Root()))

在本例中，我们使用 uwsgi 作为网络服务器，并以

uwsgi --socket 127.0.0.1:8080 --enable-threads --protocol=http --wsgi-file mycherry.py --callable wsgiapp -H ~/.local/share/virtualenvs/cherrypyapp-C1BUba0z

其中 ~/.local/share/virtualenvs/cherrypyapp-C1BUba0z 是从 pipenv 到本地 virtualenv 的路径

猎鹰 WSGI

Falcon 框架也可以通过 WSGI 封装器进行工具化：

import falcon

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

app = falcon.API()

# ...

# Wrap the application with the Instana WSGI Middleware
app = InstanaWSGIMiddleware(app)

然后，以启动堆栈 uwsgi --http :9000 --enable-threads --module=myfalcon.app 为例

基于 Gevent 的应用程序

Instana 支持基于 gevent 1.4 及更高版本的应用程序。

如果手动导入 Instana Python 包，那么请确保首先执行 gevent 导入和 Monkey 修补。

    from gevent import monkey
    monkey.patch_all()
    import instana # <--- after the gevent monkey patching of stdlib

在 Instana Python Tracer 2.5.0 之前，基于 gevent 的应用程序不得使用不修改代码激活软件包的方法（该方法使用 AUTOWRAPT_BOOTSTRAP 环境变量）。 由于 gevent 的一阶猴子修补要求（如前所述），这种方法行不通。 在这种情况下，请使用更改代码激活方法。

从 Instana Python Tracer 2.5.0 开始，当使用 AutoTrace 网络钩子或无需更改代码的激活方法时，跟踪器会自动执行 monkey.patch_all() 。 您可以通过设置 INSTANA_GEVENT_MONKEY_OPTIONS 环境变量。 使用这个以逗号分隔的列表，您可以指定要从猴子补丁中包含或排除的模块，作为 MONKEY OPTIONS 给 gevent 的 gevent.monkey.main 功能。

下面的示例显示了为猴子补丁定制模块的可用选项：

export INSTANA_GEVENT_MONKEY_OPTIONS='--no-socket, --dns, --no-time, --select, --no-ssl'

export INSTANA_GEVENT_MONKEY_OPTIONS='no-socket, dns, no-time, select, no-ssl'

export INSTANA_GEVENT_MONKEY_OPTIONS='no-socket,dns,no-time,select,no-ssl'

如果将 Django 与 gevent 和 Instana 自动跟踪一起使用，请确保在自动跟踪启动前设置 DJANGO_SETTINGS_MODULE 环境变量。 有关 DJANGO_SETTINGS_MODULE 环境变量的更多信息，请参阅 Django 文档。

如果这种自定义程度仍然不够，则可使用更改代码激活法激活软件包。

线程

Python 仪器会创建一个轻量级后台线程，定期收集和报告进程指标。 默认情况下，在 uWSGI 下禁用 GIL 和线程。 如果要对在 uWSGI, 下运行的应用程序进行检测，请确保通过 --enable-threads 命令（或 INI 风格的 enable-threads = true ）启用线程。 更多信息，请参阅 uWSGI 文档。

uWSGI 例子命令行

uwsgi --socket 0.0.0.0:5000 --protocol=http -w wsgi -p 4 --enable-threads

uWSGI 示例：INI 文件

[uwsgi]
http = :5000
master = true
processes = 4
enable-threads = true # required

预装入

Python 仪器会创建一个轻量级后台线程，定期收集和报告进程指标。 默认情况下，在 Gunicorn 中分叉 Worker 后的应用程序代码进程。 如果要对在 Gunicorn 下运行的应用程序进行检测，请确保通过 --preload 命令启用预加载。 更多信息，请参阅 Gunicorn 文档。

Gunicorn 示例命令行

要在预加载的情况下运行 Gunicorn，请使用本例中显示的以下命令：

gunicorn -w 4 --preload "file:app"

Gunicorn 示例配置文件

要在配置文件中使用 Gunicorn，请在 Python 文件中使用以下变量。 在 Gunicorn 命令中添加 -c file_name.py 。

bind = "0.0.0.0:8000"
workers = 4
preload_app = true  # required

环境变量

您可以通过以下环境变量配置忽略的端点，以按服务过滤端点：

• INSTANA_IGNORE_ENDPOINTS_PATH通过外部YAML文件配置过滤规则。
• INSTANA_IGNORE_ENDPOINTS仅根据方法名排除代码段。

INSTANA_IGNORE_ENDPOINTS_PATH=/absolute/path/to/config.yaml

tracing:
  ignore-endpoints:
    redis:
      - get
      - type
    dynamodb:
      - query
    kafka:
      - send 

tracing:
  ignore-endpoints:
    kafka: 
      - methods: ["consume"]
        endpoints: ["topic1", "topic2"]

      - methods: ["consume", "send"]
        endpoints: ["topic3"]

      - methods: ["*"] # Applied to all methods
        endpoints: ["topic4"]

      - methods: ["consume"]
        endpoints: ["*"] # Applied to all endpoints

INSTANA_IGNORE_ENDPOINTS=redis:get,type

INSTANA_IGNORE_ENDPOINTS=redis

INSTANA_IGNORE_ENDPOINTS=redis:get,type;dynamodb:query,scan;kafka:send

代码内配置

要使用代码内配置方法忽略端点，请将以下配置传递到 src/instana/configurator.py 文件：

config["tracing"]["ignore_endpoints"] = { "redis": ["get", "type"] }

此配置将排除 包 Redis 中的 和 TYPE 命令 GET 的跟踪。

要忽略包 Redis 中的所有端点，请将以下配置传递给文件 src/instana/configurator.py ：

config["tracing"]["ignore_endpoints"] = { "redis": [] }

要过滤多个服务，可以使用以下配置：

config["tracing"]["ignore_endpoints"] = {
    "redis": ["get", "type"], 
    "dynamodb": ["query", "scan"], 
    "kafka": ["send"]
}

此配置过滤以下跨度：

• GET 以及 TYPE 命令在 Redis
• QUERY 以及 SCAN 命令在 DynamoDB
• SEND 方法在 Kafka 以及所有下游跨度中

以下示例展示了按方法和端点进行过滤：

config["tracing"]["ignore_endpoints"] = {
    "kafka": [
        { methods: ["consume"], endpoints: ["topic1", "topic2"] },
        { methods: ["send"], endpoints: ["topic3"] }
    ]
}

此配置过滤以下跨度：

• CONSUME 方法用于 topic1 和 topic2 在 Kafka 以及所有下游跨度
• SEND 方法用于 topic3 在所有下游 Kafka 跨度中

您可以在同一配置中同时使用两种过滤选项（仅方法过滤和方法与端点过滤）。

代理配置

要使用代理配置方法排除端点，请在代理 configuration.yaml 文件中添加 ignore-endpoints 配置。 更多信息，请参阅忽略端点部分。