このドキュメントでは、構造化ロギングのコンセプトと、ログエントリのペイロード フィールドに構造を追加する方法について説明します。ログペイロードが JSON オブジェクトとしてフォーマットされ、そのオブジェクトが jsonPayload フィールドに保存されている場合、ログエントリは構造化ログと呼ばれます。これらのログでは、特定の JSON パスを検索するクエリを作成できます。また、ログペイロード内の特定のフィールドをインデックスに登録できます。一方、ログペイロードが文字列としてフォーマットされ、textPayload フィールドに格納されている場合、ログエントリは非構造化になります。テキスト フィールドは検索できますが、コンテンツをインデックスに登録することはできません。
構造化ログエントリを作成するには、次のいずれかを行います。
entries.writeAPI メソッドを呼び出し、完全にフォーマットされたLogEntryを指定します。gcloud logging writeコマンドを使用します。
これらのアプローチの詳細については、以降のセクションをご覧ください。
gcloud CLI を使用してログを書き込む
ログデータを書き込むには、gcloud CLI を使用します。このインターフェースは、非構造化ログと構造化ログをサポートしています。構造化ログを書き込むには、シリアル化された JSON オブジェクトをコマンドに指定します。
クイックスタートについては、Google Cloud CLI を使用したログエントリの書き込みとクエリをご覧ください。
コード例については、gcloud logging write リファレンスをご覧ください。
次のステップ
ログエントリをクエリして表示するには、ログ エクスプローラを使用してログを表示するをご覧ください。
Google Cloud CLI を使用してログエントリを読み取る方法については、ログエントリを読み取るをご覧ください。
Logging API を介してログエントリを読み取る場合は、
entries.listメソッドをご覧ください。