set_user_id (Python エージェント API)

構文

newrelic.agent.set_user_id(user_id)

set_user_id メソッドを使用して、 Transaction イベントでエンド ユーザーを識別する標準化された方法。

このメソッドは、 Transaction イベントでエンド ユーザーを識別する標準化された方法であるユーザー トラッキングに使用されます。

要件

Python エージェント バージョン 8.8.0 以降。

説明

この呼び出しは、エンド ユーザーを特定のトランザクションまたはエラー イベントに関連付けるために、トランザクションのコンテキスト内で使用されます。これにより、顧客は特定のエンド ユーザーに関する洞察を得ることができます。

パラメーター

戻り値

None。

成功すると、API はユーザー ID をエージェント属性として追加します。

失敗した場合、API はエージェント属性として enduser.id を追加しません。障害はいくつかの理由で発生する可能性があります。

• 現在のトランザクションは有効ではありません。
• API への入力として何も提供されませんでした。
• 何かが提供されましたが、文字列ではありませんでした。

使用例

バックグラウンド タスク内でユーザー ID を設定する

シンプルな Flask アプリ内で set_user_id を使用してトランザクションのユーザー ID を設定する例:

from flask import Flask
import newrelic.agent

app = Flask("Flask Test App")

@app.route("/")
def hello():
    try:
        newrelic.agent.set_user_id("my-user-id")
        raise ValueError("Oh no!")
    except:
        newrelic.agent.notice_error()
    return "Hello World!"

if __name__ == '__main__':
    app.run()