Python 配置-配置 Instana 套件

已淘汰: 透過主機代理程式進行 Python AutoTrace 的舊式自動安裝

監視 Python 應用程式的偏好方法是 AutoTrace WebHook。 不過，此方法僅適用於 Kubernetes/OpenShift。 不在 Kubernetes上且尚未完成 手動檢測 的客戶可以暫時執行下列動作:

在主機中安裝「Instana 主機代理程式」之後，它可以定期掃描是否執行 Python 程序，並以追溯方式自動套用 Instana Python 檢測。

此程序由 Instana 主機代理程式控制，可以使用 configuration.yaml 檔案的變更來自訂。 如需此檔案的完整資料，請參閱 代理程式配置頁面 ，但如需 Python的特性，請繼續閱讀。

您可以在 Instana 主機代理程式的 configuration.yaml 檔案中使用下列區塊，選擇性地啟用及配置 Python 自動檢測。 若要查看每一個選項執行的動作，請參閱行內說明:

com.instana.plugin.python:
  # Python AutoTrace will automatically find and instrument Python processes.
  # This is supported on Linux 64bit Python processes.
  autotrace:
    # Valid values: true, false
    enabled: true

    # The AutoTrace includes are used to identify python processes.  They are applied
    # _before_ the excludes to get a list of potential candidate processes.  The
    # includes are used to create a list of processes that contain the following strings
    # in their command line.  Items specified here will _override_ the defaults.
    # Matching is case sensitive.
    includes:
      - 'uwsgi'
      - 'python'

    # The AutoTrace excludes used to identify processes to ignore.  It is applied
    # _after_ the includes.  Any processes that have the following strings in their
    # command line will be ignored.  Items specified here will be added to the built
    # in defaults.
    # Matching is case sensitive.
    excludes:
      - 'pipenv'         # pipenv processes
      - 'setup.py'       # Package development

    cat /proc/sys/kernel/yama/ptrace_scope

AutoProfile™

AutoProfile 會自動且連續地將程序設定檔產生並報告給 Instana。 在 分析設定檔 區段中進一步瞭解設定檔。

若要啟用 AutoProfile ，請設定環境變數 INSTANA_AUTOPROFILE=true。 目前僅 手動安裝 支援 AutoProfile 。 請確定 Instana 感應器已在主要執行緒中起始設定。

主機代理程式通訊

Instana Python 套件會嘗試透過 IP 127.0.0.1 與 Instana 代理程式進行通訊，並透過主機的預設閘道作為容器化環境的撤回。 如果代理程式無法在下列任一位置使用，您可以使用環境變數來配置在何處尋找 Instana 主機代理程式。

應該在執行中處理程序的環境中設定環境變數。

export INSTANA_AGENT_HOST = '127.0.0.1'
export INSTANA_AGENT_PORT = '42699'

另請參閱：

• 配置 Kubernetes
• 一般參照: 語言感應器的環境變數

設定服務名稱

依預設， Instana 會盡最大努力適當地命名您的服務。 如果您基於任何原因而想要自訂服務的命名方式，則可以透過設定環境變數來執行此動作:

export INSTANA_SERVICE_NAME=myservice

另請參閱 一般參照: 語言感應器的環境變數

設定處理程序名稱

使用 INSTANA_PROCESS_NAME 來設定代表 Python 處理程序之基礎架構實體的自訂標籤。

套件配置

Instana 套件包含一個執行時期配置模組，用來管理各種元件的配置。

附註: 隨著套件的發展，將在這裡新增其他選項

from instana.configurator import config

# To enable tracing context propagation across Asyncio ensure_future and create_task calls
# Default is false
config['asyncio_task_context_propagation']['enabled'] = True

除錯及更詳細

將 INSTANA_DEBUG 設為非零值將啟用額外記載輸出，通常有助於開發及疑難排解。

export INSTANA_DEBUG="true"

另請參閱 一般參照: 語言感應器的環境變數

停用自動檢測

這個 Instana 套件包含在套件載入時起始設定的自動檢測。 此檢測提供 Instana 儀表板的分散式追蹤資訊。 若要查看自動檢測的完整清單，請參閱 支援的版本 文件。

您可以透過設定環境變數 INSTANA_DISABLE_AUTO_INSTR來停用自動檢測 (追蹤)。 這將暫停載入內建於感應器中的設備測試。

Kubernetes

在此平台上的某些實務範例中， Python 感應器可能無法自動找到並聯絡 Instana 主機代理程式。 若要解決此問題，請參閱文件中的 Configuring Agent Network Access for Kubernetes 一節。

另請參閱：

• Python 主機代理程式通訊
• 一般參照: 語言感應器的環境變數

Django (手動)

設定 AUTOWRAPT_BOOTSTRAP=instana 環境變數時，應該會自動偵測並檢測 Django 架構。 如果基於某些原因，您偏好或需要手動檢測 Django ，則可以改為將 instana.instrumentation.django.middleware.InstanaMiddleware 新增至 settings.py中的 MIDDLEWARE 清單:

import os
import instana

# ... <snip> ...

MIDDLEWARE = [
    'instana.instrumentation.django.middleware.InstanaMiddleware',
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

角錐體

從: Instana Python 套件 1.22.0

Instana 套件包含對「金字塔」的手動支援。 若要將可見性新增至「金字塔型」應用程式，請執行下列動作:

1. 確保 instana 套件已新增至 requirements.txt 並安裝在虛擬環境或儲存器中
2. 將 import instana 新增至「金字塔」應用程式的 __init__.py 檔案頂端
3. 將 Instana 檢測 Tween 新增至您的配置

import instana

with Configurator(settings=settings) as config:
    # ...
    config.include('instana.instrumentation.pyramid.tweens')
    # ...

例如：

如果您在 production.ini 配置中設定 pyramid.tweens 選項，請確定 instana.instrumentation.pyramid.tweens.InstanaTweenFactory 是此清單中的第一個項目:

pyramid.tweens =
    instana.instrumentation.pyramid.tweens.InstanaTweenFactory
    # other tweens

在 Instana 套件的未來版本中，將不需要這些手動步驟，當偵測到「金字塔」時，會自動執行這些手動步驟。

WSGI 與 ASGI 堆疊

Instana 感應器包括可新增至任何相容堆疊的 WSGI 及 ASGI 中介軟體。 這是針對各種堆疊自動執行的，但也可以針對我們尚未新增隱含支援的那些堆疊手動執行。

一旦安裝 Instana Python 套件 (透過 pip install instana) ，一般用法如下:

import instana

from instana.middleware import InstanaWSGIMiddleware
# or
from instana.middleware import InstanaASGIMiddleware

# Wrap the wsgi app in Instana middleware (InstanaWSGIMiddleware)
wsgiapp = InstanaWSGIMiddleware(MyWSGIApplication())

我們正在針對所有主要架構進行自動化，但在此同時，對於我們尚未自動支援的那些架構，有一些特定的快速入門。

附註: 先前的 from instana.wsgi import iWSGIMiddleware 匯入形式仍可運作，但已淘汰。 該匯入表單的支援將在未來版本中移除。

# 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)

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 --socket 127.0.0.1:8080 --enable-threads --protocol=http --wsgi-file mycherry.py --callable wsgiapp -H ~/.local/share/virtualenvs/cherrypyapp-C1BUba0z

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)

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

uWSGI Web 伺服器

tldr; 請確定已針對 uwsgi 啟用 enable-threads 。

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

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

一般使用者監視 (EUM)

Instana 提供深度一般使用者監視，可鏈結伺服器端追蹤與瀏覽器事件，以提供從伺服器到瀏覽器的完整視圖。

如需詳細資料，請參閱 一般使用者監視 頁面。

另請參閱

• Python 概觀
• Python 配置
• Python 追蹤 SDK
• Python OpenTracing
• OpenTracing 最佳作法
• Python 疑難排解
• Python 支援的元件及版本
• Python Github 儲存庫