ログの出力仕様

ログファイルの提供形式

以下のファイルを1つにまとめたアーカイブファイルを提供します。

プロジェクトに関係する操作ログは、プロジェクトIDごとのファイルに分けられます。
プロジェクトに関係しない操作ログは、1つのファイルにまとめられます。

ログファイルの命名規約

ログファイルの命名規約は以下のとおりです。

アーカイブファイル

利用者のオブジェクトストレージ[S3互換]に格納されるファイルです。
```
apiep_{アーカイブファイルの作成日時}_{ドメインID}.tgz
```
ヒント:
例）
```
apiep_201905301500_a7b422cc628e430c8a6f2162c75bfa65.tgz
```
ログファイル

アーカイブされたログファイルです。
```
apiep _{YYYYMMDDhh00}_{ドメインID}_{プロジェクトID or common}.log
```
ヒント:
例）
- YYYYMMDDhh00は、FJcloud-O がAPIを何時台に受け付けたかを示します。
  
  2022年8月31日の12時台に受け付けたAPIの操作ログの場合
```
apiep_202208311200_{ドメインID}_{プロジェクトID or common}.log
```
- プロジェクトに関係する操作ログの場合
```
apiep_202208311200_a7b422cc628e430c8a6f2162c75bfa65_7948d927706247b4a449123a516a07e1.log
```
- プロジェクトに関係しない操作ログの場合
```
apiep_202208311200_a7b422cc628e430c8a6f2162c75bfa65_common.log
```

ログファイルの格納先パス

利用者のオブジェクトストレージ[S3互換]バケットのログファイルパスは以下のとおりです。

{アーカイブファイルの作成日時(YYYYMMDD)}/{ドメインID}/{ログファイル名}

ヒント:

例）ログファイルの格納パス

20190530/a7b422cc628e430c8a6f2162c75bfa65/apiep_201905301500_a7b422cc628e430c8a6f2162c75bfa65.tgz

ログの出力形式

ログの出力形式は以下のとおりです。

{リクエストID} {リクエスト日時}
{リクエストID} {リクエスト元IPアドレス}
{リクエストID} {認証情報}
{リクエストID} {リクエストメソッド}
{リクエストID} {リクエストURL}
{リクエストID} {リクエストヘッダ}
{リクエストID} {リクエストボディ}
{リクエストID} {レスポンス日時}
{リクエストID} {X-Subject-Token}
{リクエストID} {レスポンスステータス}
{リクエストID} {レスポンスヘッダ}
{リクエストID} {レスポンスボディ}

ヒント:

出力例

api2-rmp1.management.jp-east-3.local-13983-1473-4 2017-05-13T13:37:52,516Z
api2-rmp1.management.jp-east-3.local-13983-1473-4 192.168.0.44
api2-rmp1.management.jp-east-3.local-13983-1473-4 
api2-rmp1.management.jp-east-3.local-13983-1473-4 POST
api2-rmp1.management.jp-east-3.local-13983-1473-4 https://identity.jp-east-3.cloud.globalfujitsu.com/v3/auth/tokens
api2-rmp1.management.jp-east-3.local-13983-1473-4 "Content-Type:applicatiion/json" "Accept:application/json" 
api2-rmp1.management.jp-east-3.local-13983-1473-4 {"auth":{"identity":{"methods":["password"],"password":{"user":{"domain":{"name"":"o4qRv2b0"}, "name": "portalIntegration14", "password": "***"}}}}}
api2-rmp1.management.jp-east-3.local-13983-1473-4 2017-03-13T13:38:09,402Z
api2-rmp1.management.jp-east-3.local-13983-1473-4 gAAAAABbxEKhnJ7DLt2ZYzz1sbrX9MFwjfMvFmiT-ShF1IlC2NQgRlFfLcTHJ5Le9FPjohacjt2G7ogDn4DS5XXqCIg0g27-FU4NwoJiDBYkHX6rPptVGu2gbxEUdayh-worg-Z4u8F5_F5m7RJJzsO21d1zab_RYkIhs581gAL1EJkNzw6V6XE
api2-rmp1.management.jp-east-3.local-13983-1473-4 201
api2-rmp1.management.jp-east-3.local-13983-1473-4 "X-Subject-Token:gAAAAABbxEKhnJ7DLt2ZYzz1sbrX9MFwjfMvFmiT-ShF1IlC2NQgRlFfLcTHJ5Le9FPjohacjt2G7ogDn4DS5XXqCIg0g27-FU4NwoJiDBYkHX6rPptVGu2gbxEUdayh-worg-Z4u8F5_F5m7RJJzsO21d1zab_RYkIhs581gAL1EJkNzw6V6XE" "Vary: X-Auth-Token" "Date: Wed, 02 Sep 2015 08:35:35 GMT" "Content-Type: application/json" "Content-Length: 8237"
"Vary: X-Auth-Token" "Date: Wed, 02 Sep 2015 08:35:35 GMT" "Content-Type: application/json" "Content-Length: 8237"
api2-rmp1.management.jp-east-3.local-13983-1473-4 Masked because it contains a password-string

ログの出力内容

ログに出力する内容は以下のとおりです。

表 1. ログの出力内容
項目	サイズ	説明
リクエスト日時	24Byte（固定）	APIリクエストを受け付けた日時（UTC）以下の形式で出力します。 yyyy-MM-ddThh:mm:ss,SSSZ yyyy: 年（西暦） MM: 月 dd: 日 hh: 時 mm: 分 ss: 秒 SSS: ミリ秒 Z: 協定世界時（UTC）を示す記号
リクエストID	ホスト名のバイト数+13Byte（固定）	APIリクエストに設定される一意のID 以下の形式で出力します。 [ホスト名]-NNNNN-NNNN-N N: 10進数
リクエスト元IPアドレス	0～15Byte	リクエスト送信元のIPアドレス（IPv4） X-Forwarded-Forヘッダの値を以下の形式で出力します。 xxx.xxx.xxx.xxx
認証情報	0～250Byte	トークンID リクエストヘッダにトークンヘッダ（X-Auth-Token）が指定されている場合に出力します。以下の形式で出力します。 <トークンID> トークンヘッダが指定されていない場合は、空文字を出力します。
リクエストメソッド	0～7Byte	以下の形式で出力します。 <リクエストメソッド名>
リクエストURL	0～1000Byte	以下の形式で出力します。 <リクエストURL（クエリを含む）> リクエストURLがURLエンコードされている場合、デコードせずに出力します。
リクエストヘッダ	0～1000Byte	以下の形式で出力します。 "ヘッダ名:ヘッダ値" 複数のヘッダが存在する場合は、半角空白で区切って出力します。
リクエストボディ	0～1000Byte	以下の形式で出力します。リクエストボディの内容以下のコンテンツタイプの場合に出力します。 application/json application/xml text/xml その他の場合は、空文字を出力します。以下の文字列についてはマスクして出力します。リクエストボディにパスワード関連の認証情報（”pass”を含む文字列）が含まれていた場合は、リクエストボディを” Masked because it contains a password-string”に設定して出力します。利用者管理APIのパスワード認証方式の場合は、リクエストボディのpasswordの値を”***”に設定して出力します。
レスポンス日時	24Byte（固定）	APIのレスポンスを返却した日時（UTC）以下の形式で出力します。 yyyy-MM-ddThh:mm:ss,SSSZ yyyy: 年（西暦） MM: 月 dd: 日 hh: 時 mm: 分 ss: 秒 SSS: ミリ秒 Z: 協定世界時（UTC）を示す記号
X-Subject-Token	0～250Byte	トークンID レスポンスヘッダにトークンヘッダ（X-Subject-Token）が指定されている場合に出力します。以下の形式で出力します。トークンID トークンヘッダが指定されていない場合は、空文字を出力します。
レスポンスステータス	3Byte（固定）	以下の形式で出力します。 3桁の数字(10進数)
レスポンスヘッダ	0～1000Byte	以下の形式で出力します。 "ヘッダ名:ヘッダ値" 複数のヘッダが存在する場合は、半角空白で区切って出力します。以下のヘッダは出力対象外です。 Content-Length Connection Date
レスポンスボディ	0～1000Byte	以下の形式で出力します。レスポンスボディの内容以下のコンテンツタイプの場合に出力します。 application/json application/xml text/xml text/plain その他の場合は、空文字を出力します。以下の文字列についてはマスクして出力します。リクエストボディにパスワード関連の認証情報（”pass”を含む文字列）が含まれていた場合は、リクエストボディを” Masked because it contains a password-string”に設定して出力します。オブジェクトストレージ [S3互換]の"Create s3-access-key"のAPIの場合は、レスポンスボディのsecretAccessKeyの値を”***”に設定して出力します。

ヒント:

改行コード（CRLF／LF）は半角空白に変換します。

最大出力サイズに到達した場合は、末尾に<半角空白+ピリオド3つ>（4Byte）を付与します。

以下は、レスポンスボディのサイズが1000Byteを超えた場合の出力例です。

api2-rmp1.management.jp-east-3.local-13983-1473-4 {"token": {"methods": ["password"], "roles": [{"id": "9fe2ff9ee4384b1894a90878d3e92bab", "name": "_member_"}, {"id": "df7d043a09d34a7c9e2bad15926ee097", "name": "cpf_org_manager"}, {"id": "3af119c426a742999e7890f6d1f70b36", "name": "cpf_admin"}], "expires_at": "2017-05-12T07:38:09.155614Z", "project": {"domain": {"id": "8be49900e8634d87a9b4ac4f9820d33b", "name": "o4qRv2b0"}, "id": "a9b6905d51e640d8ada9d2fd3b373d4d", "name": "o4qRv2b0-prj"}, "catalog": [{"endpoints": [{"name": "objectstorage", "url": "https://objectstorage.jp-east-3.cloud.globalfujitsu.com/v1/AUTH_a9b6905d51e640d8ada9d2fd3b373d4d", "region": "jp-east-1", "interface": "public", "id": "b506af0e016a4b5fb592f196da569a41"}], "type": "object-store", "id": "024329e4fde148e58ecd90b7d9872438"}, {"endpoints": [{"name": "keymanagement", "url": "https://keymanagement.jp-east-3.cloud.globalfujitsu.com/v1", "region": "jp-east-1", "interface": "public", "id": "0419c448001845af8f6828cf49745e72"}], "type": "keystore", "id": "07f309b0ef9d42758ea4de47bdca9c32"}, { ...