:データの書き込み

書き込みモードとレスポンス

TSDB は 4 つの書き込みモードをサポートしています。各モードを使用するには、次の手順に基づいてリクエストパラメーターを設定します。

• シンプルモード

  api/put 操作を呼び出すときにパラメーターを設定しないで、このモードを使用します。データが TSDB に正常に書き込まれた場合、ステータスコード 204 が返されます。データの書き込みに失敗した場合、対応するエラーコードとエラーメッセージのみが返されます。

  このモードは、一般的なビジネスの監視データのレポートに適しています。

• 統計モード

  api/put 操作を呼び出すときに summary パラメーターを設定して、このモードを使用します。データが TSDB に正常に書き込まれたかどうかに関係なく、success パラメーターと failed パラメーターが返されます。これは、ビジネスの統計情報を収集するのに役立ちます。success パラメーターは、書き込まれたデータポイントの数を示します。failed パラメーターは、書き込みに失敗したデータポイントの数を示します。

  パラメーター	タイプ	説明
  success	整数	正常に書き込まれたデータポイントの数。
  failed	整数	書き込みに失敗したデータポイントの数。

  例：

  {
      "failed":0, // 失敗したデータポイントの数
      "success": 20 // 成功したデータポイントの数
  }

  重要

  統計モードでは、api/put リクエストのデータポイントはすべて正常に書き込まれるか、すべて書き込みに失敗します。データ書き込みに失敗した場合、failed パラメーターはリクエストで指定されたデータポイントの数を示します。

  統計モードは、レポートされたデータの統計情報を必要とする一般的なビジネスの監視データのレポートに適しています。

• 詳細モード

  詳細モードは統計モードの拡張です。api/put 操作を呼び出すときに details パラメーターを設定して、このモードを使用します。 データが TSDB に正常に書き込まれたかどうかに関係なく、success、failed、および errors パラメーターが返されます。success パラメーターは、書き込まれたデータポイントの数を示します。failed パラメーターは、書き込みに失敗したデータポイントの数を示します。errors パラメーターは、書き込み失敗の直接の原因を示します。

  パラメーター	タイプ	説明
  success	整数	正常に書き込まれたデータポイントの数。
  failed	整数	書き込みに失敗したデータポイントの数。
  errors	配列	書き込みに失敗した最初のデータポイントの失敗の直接の原因。値は、データポイントに関する情報と失敗原因で構成される配列です。

  例：

  {
      "errors":[{ // エラー情報
              "datapoint":{ // データポイント
                  "metric":"sys.cpu.nice", // メトリック名
                  "timestamp":1365465600, // タイムスタンプ
                  "value":"NaN", // 値
                  "tags":{ // タグ
                      "host":"web01" // ホスト
                  }
              },
              "error":"Unable to parse value to a number" // エラーメッセージ
          }],
      "failed":1, // 失敗したデータポイントの数
      "success":0 // 成功したデータポイントの数
  }

  重要

  詳細モードでは、api/put 操作を呼び出す 1 つのリクエスト内のデータポイントは、すべて書き込まれるか、すべて書き込みに失敗します。errors の値には、書き込みに失敗した最初のデータポイントに関する情報と失敗の直接の原因のみが含まれます。書き込みに失敗したデータポイントの数を表示するには、failed パラメーターの値を表示します。

  このモードは、レポートされたデータの統計情報と障害箇所の特定を必要とするビジネスの監視データのレポートに適しています。

• フォールトトレラントモード

  api/put 操作を呼び出すときに ignoreErrors パラメーターを設定して、このモードを使用します。 フォールトトレラントモードで TSDB にデータポイントのバッチを書き込むリクエストを送信すると、1 つのデータポイントの書き込み失敗は他のデータポイントの書き込みに影響を与えません。このモードでは、有効なデータポイントと無効なデータポイントが同じバッチに存在する場合、ほとんどのデータポイントを TSDB に書き込むことができます。書き込みに失敗したデータポイントは、レスポンスで列挙されます。レスポンスには、リクエストで details パラメーターを設定した場合に返されるのと同じパラメーターが含まれます。ただし、errors パラメーターには、書き込みに失敗した各データポイントの名前と失敗原因が含まれます。errors パラメーターの値に含まれていないデータポイントは、TSDB に正常に書き込まれました。

  パラメーター	タイプ	説明
  success	整数	正常に書き込まれたデータポイントの数。
  failed	整数	書き込みに失敗したデータポイントの数。
  errors	配列	書き込みに失敗した各データポイントと対応する失敗原因の配列。

  例：

  重要

  フォールトトレラントモードでは、バッチ内のすべてのデータポイントが書き込みに失敗したわけではない場合、ステータスコード 200 が返されます。基盤となるストレージの障害などの重大なエラーにより、バッチ内のすべてのデータポイントが書き込みに失敗した場合、200 以外のステータスコードが返されます。フォールトトレラントモードでは、failed パラメーターは書き込みに失敗したデータポイントの数を示します。

  このモードは、レポートされたデータの整合性と、失敗したデータポイントの障害修正と再書き込みを必要とするビジネスの監視データのレポートに適しています。