11. 操作ログ転送機能

11.1. 概要

Smart Data Platform(以下SDPF)では、お客さまによる操作ログを転送する機能を提供します。
この機能を活用することにより、お客さまシステムの監査対応をはじめ、トラブル時の早期解決に役立てていただくことが可能となります。
転送設定はSDPFポータルの画面、またはAPIから行うことができます。設定方法については チュートリアル 、または APIリファレンス をご確認ください。

11.2. 機能一覧

表 11.2.1 操作ログ転送の機能一覧

機能

内容

操作ログの転送

Smart Data Platformポータル(以下SDPFポータル)/各メニューのコンソールおよびAPIを用いた、各種リソースに対する作成・削除・参照・更新などの操作ログをお客さまが指定するWasabiオブジェクトストレージ、またはMicrosoft AzureのAzure Blob Storage(以下Azure Blob Storage)に転送します。

操作ログ転送管理(GUI)

お客さまはSDPFポータルの画面により、ストレージの登録・削除、ユーザーの紐づけ・紐づけ解除、転送ステータスの管理、転送テストを行えます。

操作ログ転送管理(API)

お客さまはAPIにより、ストレージの登録・削除、ユーザーの紐づけ・紐づけ解除、転送ステータスの管理、転送テストを行えます。



11.3. 機能の説明

11.3.1. ログの種類

本機能で転送されるログは、以下の種類です。

表 11.3.1.1 ログの種類

種類

内容

操作ログ

誰により、いつ、どの操作が実行されたかを後から確認するために、SDPFポータル/各メニューのコンソールまたはAPIを用いた操作に関する履歴を記録したログ

サーバーインスタンスをGUIやAPIから作成する。



11.3.2. ユーザーの種類

  • 操作ログ転送機能では、ユーザーの種別・管理権限により2つのユーザーに分類されます。

    • 管理ユーザー:API権限管理を持つ管理ユーザー

    • 一般ユーザー:API権限管理を持たない管理ユーザーおよび一般ユーザー

※本詳細情報では「API権限管理」の権限を保持している管理ユーザーを「管理ユーザー」、またそれ以外の全ユーザーを「一般ユーザー」と表記します。

また、ユーザー種別ごとの操作対象範囲は以下となります。

表 11.3.2.1 ユーザー種別ごとの操作対象範囲

ユーザー種別

管理ユーザーが登録したストレージ

一般ユーザーが登録したストレージ

管理ユーザー

同一契約内の全ユーザーを対象に管理が可能

ストレージを登録したユーザーのみを対象に管理が可能

一般ユーザー

       ×

自身のみを対象に管理が可能


11.3.3. 転送設定

お客さまが指定するWasabiオブジェクトストレージ、またはAzure Blob Storageに操作ログの転送設定ができます。

表 11.3.3.1 転送設定

項目

説明

設定単位

ユーザー単位

設定方法

SDPFポータルの画面、またはAPIから設定を行えます。
契約単位でストレージを登録し、登録したストレージに対してユーザーを紐づけることで転送設定を行います。

設定範囲

管理ユーザーが登録したストレージには、同一契約内の全ユーザーを紐づけ可能です。
一般ユーザーが登録したストレージには、登録したユーザーのみを紐づけ可能です。
なお、パートナー再販の場合は、可視範囲内の子契約のストレージも操作できます。


11.3.4. 転送形式

お客さまが指定したWasabiオブジェクトストレージ、またはAzure Blob Storageに転送する形式は以下のとおりです。
なお、ストレージに表示される日時はUTC(協定世界時)で表示されます。

表 11.3.4.1 ログの転送形式

項目

説明

フォルダー作成ルール

年 / 月 / 日単位ごとにフォルダーが自動作成され、ログのオブジェクトファイルが格納されます。

2021/07/12のログは以下のフォルダーパスになります。
2021 / 07 / 12

オブジェクトファイル作成ルール

Create(作成)・Read(読み取り)・Update(更新)・Delete(削除)のリクエスト・レスポンスごとに1オブジェクトファイルが作成されます。
また、SDPFポータルでの操作もAPIを使用しているため、ログの転送対象となりオブジェクトファイルが作成されます。

-

オブジェクトファイル命名規則

HHMMSSnnn-{ハイフンなしUUID}.json

2021/07/12 10:29:36 のログは以下のようになります。
102936000-英数字32文字.json


11.3.5. ログフォーマット

転送されるログのフォーマットは、下記の通りです。

表 11.3.5.1 ログの項目

フィールド名

説明

statusCode

APIのレスポンスコード

200

username

SDPFのユーザーID

ecid0123456789@ecl.ntt.com

eventTime

お客さまが操作を実行した時刻(UTC(協定世界時)で表示)

2021-01-21T06:15:38+00:00

eventSource

HTTP Request Path

/v2/images/16134abf-c07e-4621-82a7-ebdb7c1abbb2

verb

APIのリクエストメソッド

GET

sourceIPAddress

APIをリクエストしたクライアントの接続元IPアドレス
(SDPFポータルから操作された場合は、本項目は空文字で出力されます。)

180.12.172.120

userAgent

APIをリクエストしたクライアントのユーザーエージェント

python-glanceclient-APINative

errorCode

-

必ず空文字で出力されます

errorMessage

-

必ず空文字で出力されます

requestQueryParameters

-

必ず空文字で出力されます

requestParameters

-

必ず空文字で出力されます

responseElements

-

必ず空文字で出力されます



11.3.6. ログの具体例


{
  "statusCode": "200",
  "username": "ecid**********@ecl.ntt.com",
  "eventTime": "2021-01-21T06:15:38+00:00",
  "eventSource": "/v2/images/16134abf-c07e-4621-82a7-ebdb7c1abbb2",
  "verb": "GET",
  "sourceIPAddress": "180.12.172.120",
  "userAgent": "python-glanceclient-APINative",
  "errorCode": "",
  "errorMessage": "",
  "requestQueryParameters": "",
  "requestParameters": "",
  "responseElements": ""
}


11.4. 操作ログ転送の管理(SDPFポータル画面)

SDPFポータルの画面から操作ログ転送機能を管理できます。

11.4.1. ストレージの登録・削除

操作ログの転送先となるストレージを登録・削除できます。
ストレージは契約単位で管理され、1つのストレージを複数のユーザーに紐づけ可能です。
ストレージの登録の際には、表の情報が必要です。

表 11.4.1.1 ストレージ登録時の入力項目

ストレージ種別

項目

説明

Wasabi

エンドポイント

Wasabiオブジェクトストレージのエンドポイント

バケット名

ログを格納するバケット名

Azure Blob Storage

コンテナー名

ログを格納するコンテナー名


注釈

  • 同一の接続先情報(エンドポイント+バケット名等)で複数のストレージを登録することは可能ですが、操作ログ転送管理画面上に重複の注意喚起が表示されます。同一の接続先情報で登録されている複数ストレージに対し、同一のユーザーを紐づけることはできません。

  • ストレージの事前準備(Wasabiオブジェクトストレージの契約・バケット作成、またはAzure Blob Storageのコンテナー作成)はお客さまにて実施してください。

  • ストレージを削除した場合、削除したストレージに紐づいているユーザーの紐づけも解除されます。



11.4.2. ユーザーの紐づけ・紐づけ解除

登録されたストレージに対して、操作ログを転送するユーザーを紐づけ・紐づけの解除ができます。
ユーザーの紐づけ時には、表の情報が必要です。

表 11.4.2.1 ユーザー紐づけ時の入力項目

ストレージ種別

項目

説明

Wasabi

アクセスキー

Wasabiオブジェクトストレージのアクセスキー

シークレットアクセスキー

Wasabiオブジェクトストレージのシークレットアクセスキー

Azure Blob Storage

接続文字列

Azure Blob Storageの接続文字列


注釈

  • 認証情報(アクセスキー、シークレットアクセスキー、接続文字列)はシステムに保持されません。ユーザーを紐づけるたびに入力が必要です。

  • ユーザーの紐づけを行うと、操作ログの転送設定が自動的に有効化されます。



11.4.3. 転送ステータスの管理

転送ステータスを確認・変更できます。
各ユーザーの操作ログ転送の状態には、以下の転送ステータスがあります。

表 11.4.3.1 転送ステータスの一覧
転送ステータス
(画面表示)
転送ステータス
(内容)

状態

補足

activated

有効
操作ログの転送が有効化設定されており、
正常に動作している状態

deactivated

無効(手動)
操作ログの転送が無効化設定されている状態

deactivated(!)

無効(自動)
操作ログの転送が有効化設定されているが、
何かしらの問題により正常に動作していない状態
※1, ※2, ※3

※1 転送ステータスが「deactivated(!)」のユーザーの転送ステータスは自動復旧機能により定期バッチで自動的に有効化が試みられます。
※2 転送ステータスが「deactivated(!)」となる原因として、転送先ストレージ側の問題発生、アクセスキー・シークレットアクセスキー・接続文字列の認証情報の変更などが想定されます。転送先ストレージ側の問題が想定される場合は、転送先ストレージ側の問題を解消後、再度ユーザーの紐づけを実施してください。転送先ストレージの認証情報の変更が想定される場合は、操作ログ転送管理画面にて再度ユーザーの紐づけを実施してください。
※3 転送ステータスが「deactivated(!)」の場合、「転送テスト」の実施はできません。



11.4.4. 転送テスト機能

ストレージへの接続設定が正しいかどうかを確認するため、テストデータを転送できます。
転送テストを実行するとテスト結果が表示され、成功の場合は対象ストレージにテストログが格納されます。

表 11.4.4.1 転送テストの結果の種類

転送テストの結果表示

説明

    ✓

転送テストの実施成功

    ×

転送テストの実施失敗


注釈

転送テストの結果がストレージに反映されるまで、数分程度の時間を要する場合があります。



11.4.5. 自動復旧機能

転送先ストレージの故障等が発生すると、操作ログの転送が一時停止します。
その際、本自動復旧機能により、システム的に操作ログ転送の再有効化を試行します。
これにより、一時的な故障からの復旧時にお客さまが手動で再有効化する必要がありません。

注釈

  • 自動復旧はシステムの定期実行スケジュールに基づいて行われるため、故障復旧後すぐに転送が再開されるとは限りません。

  • 即座に再開したい場合は、SDPFポータルの画面またはAPIからステータスを手動で有効化してください。



11.6. ご利用条件

11.6.1. 提供リージョン

JP1,JP2,JP4,JP5,JP6,JP7,JP8,JP9,GL1


11.6.2. ご利用前に準備をいただくもの

操作ログ転送機能を利用する際は、以下を事前にご準備ください。

  • 転送先のストレージ(Wasabi オブジェクトストレージまたはAzure Blob Storage)

  • 各種情報(Wasabi オブジェクトストレージまたはAzure Blob Storageの準備時に取得する情報)



11.6.3. ご利用時の注意点

(転送の自動停止について)

以下のような事象が発生している場合、システム保護とお客様情報保護のためストレージへの転送が自動的に停止(無効化)されることがあります。
  • 転送先ストレージでの故障発生

  • ストレージに設定したアカウントの書込権限が無効化された場合

  • ストレージのアクセスキーやシークレットアクセスキーが変更された場合

このような事象で、ストレージへの転送が停止(無効化)されたものは以下により再有効化が行われます。
  • 自動復旧機能により定期的な再有効化の試行

  • お客様自身が手動での再有効化

ただし、事象が解消していない場合、再度停止(無効化)されることがあります。


11.6.4. 制約事項

  • 本機能のご利用は、日本契約のお客さまのみとさせていただいております。
  • 本機能は、2022年12月時点のWasabiオブジェクトストレージ、Azure Blob Storageの仕様を基に動作確認を行っております。Wasabiオブジェクトストレージ、Azure Blob Storageの仕様が変更となった場合は適宜情報更新を行いますが、お時間をいただく場合があることをご了承ください。
  • 一般ユーザーが登録したストレージは、登録したユーザーのみを紐づけ可能です。



11.7. 料金

11.7.1. 初期費用

操作ログ転送機能の初期費用は不要です。


11.7.2. 月額費用

操作ログ転送機能の月額費用は発生しませんが、ログの転送先であるお客さまのWasabiオブジェクトストレージ、またはAzure Blob Storageについては費用が発生いたします。


11.8. サービス品質

11.8.1. サポート範囲

  • 本機能のサポート範囲は、機能一覧に掲載する各機能の仕様に関するお問い合わせまでとなります。
  • 弊社基盤から操作ログが出力された後からお客さまのストレージに格納されるまでの間・格納された後に欠損した操作ログについては、保証いたしません。
  • 操作ログの具体的な見方や、SDPFポータルやAPI経由で各メニューを操作した場合にどのようなログが転送されるかなどのお問い合わせについては、回答いたしかねます。
  • 弊社経由でご契約されたWasabiオブジェクトストレージやHybrid Cloud with Microsoft Azureについてお問い合わせ先については以下をご参照ください。
    Wasabiオブジェクトストレージ:https://sdpf.ntt.com/services/wasabi/
    Hybrid Cloud with Microsoft Azure:https://sdpf.ntt.com/services/microsoft-azure/
  • WasabiオブジェクトストレージやMicrosoft Azureを弊社経由では無くお客さまが直接ご契約されている場合は、サポートいたしかねますのでご了承ください。
  • チケットシステムにてお問い合わせの際は、対象のユーザーを明記したうえでお問い合わせをお願いいたします。


11.8.2. SLA

本機能は、SLA対象外です。


11.8.3. 操作ログ転送の反映時間

ストレージへの転送設定を有効化した後、実際に操作ログが転送されるまでに時間を要する場合があります。
操作ログ転送は、基本的には即時転送されますが、状況により最大60分程度の時間を要する場合があります。