Tableau Resource Monitoring Tool (RMT) レスポンス ヘッダー
この記事では、Tableau Resource Monitoring Tool でカスタムのレスポンス ヘッダーを設定する方法について説明します。この機能は、2024 年 8 月の RMT メンテナンス リリースで追加されました。
レスポンス ヘッダーを変更する場合は、RMT を再起動する必要があります。
重要: レスポンス ヘッダーを変更すると、RMT が壊れる可能性があります。ヘッダーを更新した場合は、変更後にテストを行い、RMT が正常に動作していることを確認してください。
カスタム レスポンス ヘッダーの表示と更新
カスタム レスポンス ヘッダーを表示および変更するには、rmtadmin get コマンドと rmtadmin set コマンドを使用します。
すべてのカスタム レスポンス ヘッダーの一覧を表示する
現在設定されているカスタム レスポンス ヘッダーの一覧を表示するには、次のコマンドを実行します。
rmtadmin get server:web:responseheaders
例:
> rmtadmin get server:web:responseheaders server:web:responseHeaders:Access-Control-Allow-Origin = * server:web:responseHeaders:Connection = Keep-Alive server:web:responseHeaders:X-Frame-Options = DENY server:web:responseHeaders:X-Cache-Info = not cacheable; meta data too large
特定のカスタム レスポンス ヘッダーの値を取得する
特定のカスタム レスポンス ヘッダーを取得するには、次を実行します。
rmtadmin get server:web:responseheader:<some header>
例:
> rmtadmin get server:web:responseheader:X-Frame-Options server:web:responseHeaders:X-Frame-Options = DENY
存在しないカスタム レスポンス ヘッダーを取得または設定しようとすると、次のエラーが表示されます。
> rmtadmin get server:web:responseheaders:<non-existent header> [ERR] Config key not found. Key: server:web:responseHeaders:<non-existent header>
複数のキーを取得できます。重複したキーは除外されます。無効なキーはリストの最後に表示されます。
> rmtadmin get server:web:responseheaders server:web:responseheaders:SomethingNew server:web:responseHeaders:Connection server:web:responseHeaders:Access-Control-Allow-Origin = * server:web:responseHeaders:Connection = Keep-Alive server:web:responseHeaders:X-Frame-Options = DENY server:web:responseHeaders:X-Cache-Info = not cacheable; meta data too large [ERR] Config key not found. Key: server:web:responseheaders:SomethingNew
特定のカスタム レスポンス ヘッダーを設定または更新する
特定のカスタム レスポンス ヘッダーを設定または変更するには、次を実行します。
rmtadmin set server:web:responseheader:<some header>
例:
> rmtadmin set server:web:responseheaders:X-Frame-Options = Allow Config value set successfully. Key: server:web:responseHeaders:X-Frame-Options server:web:responseHeaders:X-Frame-Options = Allow
ヘッダーは、完全なヘッダーと任意のキーと値のペアからなる文字列です (該当する場合)。
たとえば、次の場合、キープ アライブのタイムアウトと最大値を設定します。
rmtadmin set server:web:responseheader:connection "Keep-Alive: timeout=5, max=997" Config value set successfully. Key: server:web:responseHeaders:Connection server:web:responseHeaders:Connection = "Keep-Alive: timeout=5, max=997"
カスタム レスポンス ヘッダーを削除する
> rmtadmin set server:web:responseheaders:X-Frame-Options --remove Config value successfully removed. Key: server:web:responseHeaders:X-Frame-Options
通常の設定値を削除する
通常の設定値は削除できないため、削除しようとするとエラーが発生します。
> rmtadmin set db:username --remove [ERR] The --remove argument is not valid for this key. Key: db:username
カスタム レスポンス ヘッダー値を空の値に設定する
カスタム レスポンス ヘッダーを除くすべての rmtadmin set キーでは、値を含める必要があります。カスタム レスポンス ヘッダーを使用すると、キーを値なしに設定できます。この例では、X-Frame-Options キーを空の値に設定します。
> rmtadmin set server:web:responseheaders:X-Frame-Options Config value set successfully. Key: server:web:responseheaders:X-Frame-Options server:web:responseheaders:X-Frame-Options =
これは、X-Frame-Options ヘッダーの削除とは異なります。
なぜそうするとよいのでしょうか? RMT は既定でいくつかのカスタム レスポンス ヘッダーを生成します。キーを空の値に設定すると、RMT にヘッダーが含まれないようにすることができます。
たとえば、既定では、RMT は X-Frame-Options = Deny を含むレスポンス ヘッダーを生成します。X-Frame-Options のカスタム レスポンス ヘッダーを作成できます。
> rmtadmin set server:web:responseheaders:X-Frame-Options ALLOW
既定に戻すには、これを完全に削除するか、DENY に設定します。
> rmtadmin set server:web:responseheaders:X-Frame-Options --remove
ただし、RMT から何も送信したくない場合は、空の値に設定できます。
> rmtadmin set server:web:responseheaders:X-Frame-Options
無効なヘッダー
RMT では無効なレスポンス ヘッダーを設定できます。指定したレスポンス ヘッダーが有効でない場合、RMT は警告を表示しますが、その値を設定することはできます。レスポンス ヘッダーを更新した後、RMT が適切に動作していることを確認するのはお客様の責任です。
「responseheaders」は設定できません。個別の子キーは、レスポンス ヘッダー内でのみ設定できます。
rmtadmin set server:web:responseheaders [ERR] Key cannot be set: server:web:responseHeaders
重要: レスポンス ヘッダーに何らかの変更を加えた後は、RMT をテストしてください。