メイン コンテンツをスキップする 補完的コンテンツへスキップ

コンポーネントメトリクスのエンドポイント

メソッド エンドポイント 説明 クエリーパラメーター ボディ
GET /monitoring/observability/executions/{runId}/component 指定されたタスク実行のコンポーネントメトリクスを取得します。
  • limit: 返すエントリーの数。デフォルト値は50で、最大値は200です。
  • offset: エントリーのページネーションの開始位置で、0以上となります。
  • sortBy: 返されたエントリーのソート基準となるフィールドです。デフォルト値はcomponent_start_time_secondsです。利用できるすべての値については、sortByをご覧ください。
  • sortOrder: 返されたログのソート方法で、descとascのいずれかです。デフォルト値はdescで、これは降順であることを意味します。

    昇順か降順かにかかわらず、NULLフィールドや空のフィールドは常に、レスポンスで返されるリストの最後に置かれます。

これらのパラメーターはすべてオプションです。

 該当せず
POST /monitoring/observability/metrics/component 生のコンポーネントメトリクスデータを検索します。 パラメーターがありません。 
{
    "environmentId": "6093f6a36f01d639680d31cd", 
    "startTime": "2021-09-08T06:58:04.604Z", 
    "endTime": "2021-09-08T06:58:06.463Z", 
    "limit": 50, 
    "offset": 0, 
    "sortBy": "component_start_time_seconds", 
    "sortOrder": "asc", 
    "filters": [
       {
            "field": "engine_id", 
            "operator": "in", 
            "value": ["a60bb1c0-7669-407f-9326-138af05da18a"]
        },
        {
            "field": "component_start_time_seconds", 
            "operator": "gte", 
            "value": 1628266578
        }
    ]
}

ボディで使用するフィールドの詳細は、次のセクションをご覧ください。

観測可能なメトリクスエンドポイントで使われるフィールド

environmentId
必須の有無
タスクとそのワークスペースが属している環境のID
startTime
必須の有無
ジョブタスクにあるコンポーネントが動作を開始する時刻。使用するISO形式はyyyy-MM-dd'T'HH:mm:ss.SSS'Z'で、たとえば2021-09-08T06:58:04.604Zとなります。
endTime
必須の有無
ジョブタスクにあるコンポーネントが動作を終了する時刻。使用するISO形式はyyyy-MM-dd'T'HH:mm:ss.SSS'Z'で、たとえば2021-09-08T06:59:04.804Zとなります。

startTimeはendTimeよりも前でなくてはなりません。

limit
オプション
返すエントリーの数。デフォルト値は50で、最大値は200です。
offset
オプション
エントリーのページネーションの開始位置で、0以上となります。
sortBy
オプション
返されたエントリーのソート基準となるフィールドです。デフォルト値はcomponent_start_time_secondsです。使用されるフィールドは次のとおりです。
  • account_id
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • process_id: JVMのUUID
  • /JobName
  • pid: 現在の実行の一意ジョブ識別子
  • father_pid: 最初の直系親ジョブの一意識別子
  • root_pid: 複数のサブジョブが複数ある場合は最初のルートジョブのID
  • connector_type
  • connector_label
  • connector_id
  • target_connector_type
  • target_label
  • target_id
  • connection_type
  • connection_name
  • Availability-noteDeprecated
    component_start_time_seconds
  • component_connection_rows_total
  • component_execution_duration_milliseconds
sortOrder
オプション
返されたログのソート方法で、descとascのいずれかです。デフォルト値はdescで、これは降順であることを意味します。

昇順か降順かにかかわらず、NULLフィールドや空のフィールドは常に、レスポンスで返されるリストの最後に置かれます。

filters
オプション
monitoring/observability/metrics/componentに送信された検索リクエストでメトリクスデータをフィルタリングするために使われます。例: 
{
    "field": "connector_id", 
    "operator": "in", 
    "value": ["tMongoDBConnection_1"]
}
このフィルターはconnector_idフィールドに適用され、ID がtMongoDBConnection_1であるコンポーネントに関連するメトリクスデータを検索します。 
{
    "field": "component_start_time_seconds", 
    "operator": "gt", 
    "value": 1628266578
}
このフィルターはcomponent_start_time_secondsフィールドに適用され、1628266578より後に実行が開始されたコンポーネントに関連するメトリクスデータを検索します。 
{
    "field": "operator_type", 
    "operator": "in", 
    "value": ["HUMAN", "SERVICE"]
}
このフィルターはoperator_typeフィールドに適用され、ユーザーまたはサービスアカウントによって開始されたタスクに関連するメトリクスデータを検索します。
フィルターで使用されるフィールドは次のとおりです。
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • /JobName
  • connector_type (たとえばtMongoDBConnection)
  • connector_label (たとえばtMongoDBConnection_1)
  • connector_id (たとえばtMongoDBConnection_1)
  • component_start_time_seconds: このフィールドではgt、gte、lt、lteのみのサポート、他のフィールドではinのみのサポート
  • operator: タスクを開始するユーザーまたはサービスアカウントのID
  • operator_type: ユーザーであればHUMAN、サービスアカウントであればSERVICE
フィルターで使われる演算子は次のとおりです。
  • in: 配列で値を一致させます。
  • gt: 指定した値より後のもの。数値または数値の文字列が必要です。
  • gte: 指定した値に等しいかそれより後のもの。数値または数値の文字列が必要です。
  • lt: 指定した値より前のもの。数値または数値の文字列が必要です。
  • lte: 指定した値に等しいかそれより前のもの。数値または数値の文字列が必要です。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください