Cloud Monitor:ライブデバッグサービスタスク API リファレンス

パスパラメーター

共通の CLI パラメーター

リクエスト

POST /serviceTask/{workspace}/{serviceId}/task
Content-Type: application/json

ボディパラメーター

CLI の例

aliyun cms2 apm service-task create \
  --workspace <workspace> --service-id <serviceId> \
  --type <taskType> --ip '<targetIp>' \
  --task-config '<taskConfigJson>' \
  --region <regionId> -o json

• すべてのインスタンスに一致させるには、--ip を * に設定します。

• 生の JSON オブジェクトを --task-config に渡します。 JSON を手動でエスケープする必要はありません。

レスポンス

{
  "success": true,
  "data": {
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "taskId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
  }
}

HTTP ボディの例 (CLI シリアル化後)

{
  "type": "live_debug_log_probe",
  "ip": "*",
  "taskConfig": "{\"probeType\":\"LOG\",\"language\":\"python\",\"target\":{\"typeName\":\"app.service.order\",\"methodName\":\"OrderService.create_order\",\"location\":\"exit\",\"instanceIds\":[\"*\"]},\"action\":{\"type\":\"LOG\",\"template\":\"id={order_id}\"},\"ttl\":\"30m\",\"captureCount\":100}"
}

リクエスト

GET /serviceTask/{workspace}/{serviceId}/tasks?type={taskType}&maxResults={n}

クエリパラメーター

レスポンスフィールド

CLI は data.serviceTasks[] 配列を出力します。各項目には次のフィールドが含まれます。

CLI の例

aliyun cms2 apm service-task list \
  --workspace <workspace> --service-id <serviceId> \
  --type <taskType> --max-results 100 \
  --region <regionId> -o json

リクエスト

GET /serviceTask/{workspace}/{serviceId}/task/{taskId}?type={taskType}

クエリパラメーター

レスポンス

CLI は data.serviceTask オブジェクトを出力します。フィールドは List のレスポンス内の 1 つの項目と同じです。

CLI の例

aliyun cms2 apm service-task get \
  --workspace <workspace> --service-id <serviceId> \
  --task-id <taskId> --type <taskType> \
  --region <regionId> -o json

リクエスト

DELETE /serviceTask/{workspace}/{serviceId}/task/{taskId}?type={taskType}

クエリパラメーター

CLI の例

aliyun cms2 apm service-task delete \
  --workspace <workspace> --service-id <serviceId> \
  --task-id <taskId> --type <taskType> \
  --region <regionId> -o json

バッチ削除の例

サービスのすべてのプローブタスクを削除するには、5 種類のプローブタイプごとにタスクを一覧表示し、削除します。

WS=<workspace>; SVC=<serviceId>; REGION=<regionId>
for t in live_debug_log_probe live_debug_snapshot_probe \
         live_debug_metric_probe live_debug_span_probe live_debug_span_tag_probe; do
  aliyun cms2 apm service-task list \
    --workspace "$WS" --service-id "$SVC" --type "$t" --region "$REGION" -o json |

  python3 -c 'import sys,json; [print(t["taskId"]) for t in (json.load(sys.stdin)["data"].get("serviceTasks") or [])]' |

  while read -r id; do
    aliyun cms2 apm service-task delete \
      --workspace "$WS" --service-id "$SVC" \
      --task-id "$id" --type "$t" --region "$REGION" -o json
  done
done

CLI の例

過去 10 分間のデータをクエリします。<taskId> を、create API が返すタスク ID に置き換えてください。

FROM=$(( $(date +%s) - 600 )); TO=$(date +%s)

# タスクステータス (インストールステータス、ファネルメトリクス)
aliyun sls get-logs-v2 --region <regionId> --accept-encoding gzip \
  --project <slsProject> --logstore logstore-apm-logs \
  --from "$FROM" --to "$TO" \
  --query "* and \"<taskId>\" | SELECT content FROM log WHERE json_extract_scalar(attributes, '\$[\"livedebug.report_type\"]') = 'status'"

# キャプチャ結果 (キャプチャデータ)
aliyun sls get-logs-v2 --region <regionId> --accept-encoding gzip \
  --project <slsProject> --logstore logstore-apm-logs \
  --from "$FROM" --to "$TO" \
  --query "* and \"<taskId>\" | SELECT content FROM log WHERE json_extract_scalar(attributes, '\$[\"livedebug.report_type\"]') != 'status'"

クエリパラメーター

クエリタイプ

トップレベルフィールド

target：ターゲットの特定

行レベルのプローブでは、主に sourceFile + location:"line:N" を使用できます。

trigger：トリガー条件 (任意)

条件の例: amount > 10000 または @return is None or amount > 10000

式のルールは次のとおりです：

• パラメーター名、ローカル変数、またはモジュールレベルのグローバル変数を直接使用します。

• exit または exception の箇所では、@return、@duration (ミリ秒)、または @exception を使用します。

• OGNL、args[0]、returnValue、durationMs は使用しないでください。

• 条件が @return または @exception を参照する場合、プローブの location は exit または exception である必要があります。

rateLimit：レート制限 (任意)

デフォルトのレート制限: LOG、METRIC、SPAN、および SPAN_TAG プローブでは、毎秒約 5,000 回の実行が可能です。 SNAPSHOT プローブでは、毎秒約 1 回の実行が可能です。 行レベルのプローブには、毎秒約 100 回という追加のグローバル保護制限があります。

LOG (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
}

SNAPSHOT (taskType: live_debug_snapshot_probe)

メソッドのスナップショットをキャプチャし、オブジェクトグラフをシリアル化します。

{"name": "order_id", "type": "...", "value": "...", "notCapturedReason": null}

{
  "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"],
    "captureConfig": {
      "maxDepth": 3,
      "maxCollectionSize": 100,
      "maxStringLength": 1024
    }
  },
  "ttl": "30m",
  "captureCount": 50
}

METRIC (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 (taskType: live_debug_span_probe)

ターゲット関数の実行に対して OpenTelemetry スパンを作成します。例外が発生した場合は、スパンを ERROR としてマークし、例外イベントを記録します。関数レベルのみ。

{
  "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 (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"
}