Python コレクターの設定

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をインストルメントするには、以下のコマンドを使用してください：

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 へのパスです。

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 として を使用してスタックを起動します

Instana 1.4gevent 以降をベースとしたアプリケーションに対応しています。

Instana Python パッケージを手動でインポートする場合は、gevent import とモンキー・パッチが最初に実行されるようにしてください。

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

Instana Python Tracer 2.5.0 から、 AutoTrace のWebhookまたは「 コード変更なしで有効化する 」方法を使用すると、トレーサーは自動的に処理を実行します monkey.patch_all() 。 環境 INSTANA_GEVENT_MONKEY_OPTIONS 変数を設定することで、このモンキーパッチングを微調整できます。 このカンマ区切りのリストを使用すると、geventの gevent.monkey.main 関数 MONKEY OPTIONS と同様に、モンキーパッチングの対象とするモジュールや除外するモジュールを指定できます。

以下の例は、モンキーパッチング用のモジュールをカスタマイズするために利用可能なオプションを示しています：

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'
 

もし と gevent および Instana の自動トレース Django 機能を併用する場合は、自動トレースが開始される前に 環境 DJANGO_SETTINGS_MODULE 変数を設定しておくようにしてください。 この DJANGO_SETTINGS_MODULE 環境変数に関する詳細については、 Django のドキュメントを参照してください。

このレベルのカスタマイズではまだ不十分な場合は、Activating with code changes というパッケージの有効化方法を使います。

この Python の計測機能は、プロセスのメトリクスを定期的に収集・報告するための軽量なバックグラウンドスレッドを作成します。 uWSGI では、デフォルトで GIL とスレッド処理が無効になっています。 uWSGI, で動作するアプリケーションに計測機能を追加する場合は、コマンド --enable-threads （または enable-threads = true INI 形式）でスレッドを有効にしてください。 詳細については、『 uWSGI 』のドキュメントを参照してください。

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
 

この Python の計測機能は、プロセスのメトリクスを定期的に収集・報告するための軽量なバックグラウンドスレッドを作成します。 デフォルトでは、ワーカーがGunicornでフォークされた後、アプリケーションコードが処理される。 Gunicorn で実行されるアプリケーションに計測機能を追加したい場合は、コマンド --preload を指定してプリロードを有効にしてください。 詳しくはGunicornのドキュメントをご覧ください。

Gunicornをプリロードして実行するには、この例に示されている次のコマンドを使用してください：

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

設定ファイルを使って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 : メソッド名のみに基づいてスパンを除外する。

コード内設定の手法を用いてエンドポイントを無視するには、以下の設定をファイル 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 および TYPERedis 内のコマンド
• QUERY および SCANDynamoDB 内のコマンド
• SEND Kafka およびすべての下流のスパンにおけるメソッド

次の例は、メソッドとエンドポイントによるフィルタリングを示しています：

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

この設定では、以下のスパンがフィルタリングされます：

• CONSUME Kafkatopic2 およびすべての下流スパンにおける および topic1 に対するメソッド
• SEND Kafkatopic3 およびすべての下流スパンにおける

同じ設定内で、両方のフィルタリングオプション（メソッドのみ、およびメソッドとエンドポイント）を使用できます。

エージェントの設定を使用してエンドポイントを除外するには、エージェント configuration.yaml のファイルに設定 ignore-endpoints を追加してください。 詳細については、 「エンドポイントの無視」 のセクションを参照してください。

以下の指定を使用して、環境 INSTANA_CONFIG_PATH 変数をローカルの YAML 設定ファイルに設定します：

tracing:
  disable:
    - <category_or_type>: <boolean>

この disable キーには、カテゴリまたは type 名前のリストを指定できます。 「 type 名前」とは、 Instana Python Tracer でサポートされているフレームワーク、ライブラリ名、または計測対象名の参照を指します。 個々の type 設定は、定義順序にかかわらず、親 category の設定よりも優先されます。 このアプローチにより、より広範なカテゴリが無効化されている場合でも、特定の計測機能を有効にしておくといったきめ細かな制御が可能になります。 次の設定例では、 Redis 用のものを除き、すべてのデータベーススパンを無効にします：

com.instana.tracing:
  disable:
    - databases: true
    - redis: false

次の例に示すように、環境変数 INSTANA_TRACING_DISABLE を使用してスパンを無効にすることができます：

# Disable Redis spans
INSTANA_TRACING_DISABLE=redis

# Disable all logging spans
INSTANA_TRACING_DISABLE=logging

# Disable multiple technologies
INSTANA_TRACING_DISABLE=redis,logging

エージェントの設定を使用して Redis のspanを無効にするには、エージェントの configuration.yaml ファイルに以下の disable 設定を追加します：

com.instana.tracing:
  disable:
    - redis: true

エージェントの設定を使用してカテゴリのスパン logging を無効にするには、エージェントの configuration.yaml ファイルに以下の disable 設定を追加します：

com.instana.tracing:
  disable:
    - logging: true