Cloud Monitor:Live-Debug Agent スキルによる Python アプリケーションの診断

CLI のインストール

CLI がインストールされていない場合は、「Install Alibaba Cloud CLI」をご参照ください。ご利用のオペレーティングシステム（Linux、macOS、または Windows）に適したインストールメソッドを選択します。

インストール後、CLI が利用可能であることを確認します。

aliyun version

アクセス認証情報の設定

aliyun configure

プロンプトに従って、AccessKey ID、AccessKey Secret、およびデフォルトリージョンを入力します。RAM ユーザーを使用し、対象の Simple Log Service プロジェクトに対して CMS ServiceTask 権限および読み取り・書き込み・クエリ権限を付与してください。詳細については、「認証情報の設定と管理」をご参照ください。

CMS CLI (aliyuncms2) のインストールと可用性の確認

CMS ServiceTask の機能は、aliyuncms2 プラグインバイナリによって提供されます。aliyuncms2 を取得し、~/.aliyun/ ディレクトリ（または PATH）に配置します。その後、aliyun cms2 を通じて呼び出すことができ、認証情報は aliyun configure の構成から再利用されます。

# CMS ServiceTask 機能の確認
aliyun cms2 apm service-task --help

# SLS クエリの可用性確認
aliyun sls --help

cms2 が利用できない場合は、aliyuncms2 バイナリが ~/.aliyun/（または PATH）に存在し、実行権限が付与されていることを確認します。

ls -l ~/.aliyun/aliyuncms2
chmod +x ~/.aliyun/aliyuncms2
aliyun cms2 apm service-task --help

問題が解消しない場合は、Alibaba Cloud CLI をアップグレードして、再度お試しください。

aliyun upgrade -y

動的ログ (LOG)

例文：

/alibabacloud-livedebug スキルを使用して、app.service.order 内の OrderService.create_order の終了位置に動的ログを追加し、order_id、amount、戻り値、レイテンシを出力します。30 分間保持します。

参照構成：taskType = live_debug_log_probe

{
  "probeType": "LOG",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "exit",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "LOG",
    "template": "create_order id={order_id} amount={amount} ret={@return} cost={@duration}ms"
  },
  "ttl": "30m",
  "captureCount": 100
}

条件付きの行レベル

app/service/order.py の 42 行目にログを追加します。amount >= 1000 の場合にのみ、注文 ID と金額を出力します。

参照構成：taskType = live_debug_log_probe

{
  "probeType": "LOG",
  "language": "python",
  "target": {
    "sourceFile": "app/service/order.py",
    "location": "line:42",
    "instanceIds": ["*"]
  },
  "trigger": {
    "condition": "amount >= 1000"
  },
  "action": {
    "type": "LOG",
    "template": "big order id={order_id} amount={amount}"
  },
  "ttl": "30m"
}

メソッドスナップショット (SNAPSHOT)

例文：

/alibabacloud-livedebug スキルを使用して、OrderService.create_order の終了位置でスナップショットを取得します。入力パラメーター、ローカル変数、戻り値、呼び出しスタックをキャプチャします。最大 20 回キャプチャします。

参照構成：taskType = live_debug_snapshot_probe

{
  "probeType": "SNAPSHOT",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "exit",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "SNAPSHOT",
    "capture": ["ARGS", "LOCALS", "RETURN", "STACK"],
    "captureConfig": {
      "maxDepth": 3,
      "maxCollectionSize": 100,
      "maxStringLength": 1024
    }
  },
  "ttl": "30m",
  "captureCount": 20
}

カスタムフィールドによる条件付きフィルタリング

create_order の終了位置でスナップショットを取得します。戻り値が空であるか、金額が 10000 を超える場合にのみトリガーします。order_id、amount * count、self.user_id、および戻り値に焦点を当てます。

参照構成：taskType = live_debug_snapshot_probe

{
  "probeType": "SNAPSHOT",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "exit",
    "instanceIds": ["*"]
  },
  "trigger": {
    "condition": "@return is None or amount > 10000"
  },
  "action": {
    "type": "SNAPSHOT",
    "capture": ["ARGS"],
    "captureExpressions": [
      "order_id",
      "amount * count",
      "self.user_id",
      "@return"
    ]
  },
  "ttl": "30m",
  "captureCount": 50
}

例外キャプチャ：

PaymentService.process_payment が例外をスローした際にスナップショットをキャプチャします。入力パラメーター、例外情報、呼び出しスタックを含めます。2 時間保持します。

参照構成：taskType = live_debug_snapshot_probe

{
  "probeType": "SNAPSHOT",
  "language": "python",
  "target": {
    "typeName": "app.service.payment",
    "methodName": "PaymentService.process_payment",
    "location": "exception",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "SNAPSHOT",
    "capture": ["ARGS", "EXCEPTION", "STACK", "LOCALS"]
  },
  "ttl": "2h",
  "captureCount": 100
}

動的メトリック (METRIC)

例文：

/alibabacloud-livedebug スキルを使用して、create_order に金額のヒストグラムメトリックを追加します。ユーザーが VIP かどうかを示すタグを含めます。1 時間保持します。

参照構成：taskType = live_debug_metric_probe

{
  "probeType": "METRIC",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "exit",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "METRIC",
    "metricName": "livedebug.order.amount",
    "metricType": "HISTOGRAM",
    "valueExpression": "amount",
    "tags": {
      "is_vip": "str(user_id == 'vip')"
    }
  },
  "ttl": "1h"
}

ダイナミックスパン (SPAN)

例文：

/alibabacloud-livedebug スキルを使用して、OrderService.create_order に一時的に dyn.create_order という名前のスパンを追加します。注文 ID と金額をスパン属性として含めます。

参照構成：taskType = live_debug_span_probe

{
  "probeType": "SPAN",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "enter",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "SPAN",
    "spanName": "dyn.create_order",
    "spanTags": {
      "order.id": "str(order_id)",
      "order.amount": "str(amount)"
    }
  },
  "ttl": "1h"
}

タグ付け (SPAN_TAG)

例文：

create_order の終了位置で、/alibabacloud-livedebug スキルを使用して現在のスパンに order.id および order.result (戻り値を使用) をタグ付けします。新しいスパンは作成しません。

参照構成：taskType = live_debug_span_tag_probe

{
  "probeType": "SPAN_TAG",
  "language": "python",
  "target": {
    "typeName": "app.service.order",
    "methodName": "OrderService.create_order",
    "location": "exit",
    "instanceIds": ["*"]
  },
  "action": {
    "type": "SPAN_TAG",
    "tags": [
      {"key": "order.id", "value": "str(order_id)"},
      {"key": "order.result", "value": "str(@return)"}
    ]
  },
  "ttl": "1h"
}

エージェントから、`cms2` コマンドまたは `aliyun` コマンドが利用できないとのレポートがありました。

原因： Alibaba Cloud CLI がインストールされていない、バージョンが古すぎる、または aliyuncms2 プラグインのバイナリが準備されていません。

ソリューション：

aliyun version
aliyun upgrade -y
ls -l ~/.aliyun/aliyuncms2   # CMS CLI プラグインバイナリが存在し、実行可能であることを確認
aliyun cms2 apm service-task --help
aliyun sls --help

aliyun configure を実行して、AccessKey ペアを設定してください。

タスクは正常に作成されましたが、キャプチャ結果が表示されません。

トラブルシューティング 以下の順序でトラブルシューティングを実施します。

1. エージェントに タスクステータス を確認させ、エージェントが正常にインストールされたかどうかを確認してください。

2. typeName および methodName がランタイムモジュール名と __qualname__ と一致することを確認します。__main__ がメインモジュールとなるべきかどうかをチェックします。

3. ターゲット関数に到達するリクエストをトリガーしたことを確認してください。フィルター条件が厳しすぎないかを確認します。

4. regionId が slsProject のリージョンと一致していることを確認します。

5. クエリのタイムウィンドウを増やして、再度お試しください。

エージェントに「データがキャプチャされませんでした。ステータスとターゲットの場所が正しいかどうかを確認してください。」と指示することもできます。

SLS が ProjectNotExist をレポートする

原因： クエリに使用されたリージョンが、Simple Log Service プロジェクトのリージョンと一致していません。

ソリューション：正しい regionId を .arms-info に設定し、エージェントが LIVE_DEBUG_REGION_ID をエクスポートしていることを確認してください。CLI のデフォルトリージョンにのみ依存しないでください。

エージェントのクリーンアップ確認方法

現在のサービスにまだアタッチされている Live-Debug エージェントを表示してください。存在する場合は、すべて削除してください。

Python アプリケーションによるスレッド、メモリ、または逆コンパイルの診断は可能ですか。

いいえ。これらは Java/JVM アプリケーションでのみサポートされるコマンド機能です。Python アプリケーションの場合は、代わりにログ、スナップショット、メトリック、またはスパン診断をご利用ください。