8 ロギング、エラー・レポートおよびヘルプ情報
ロギング、エラー・レポートおよびヘルプ情報の検索は、発生の可能性がある問題のトラブルシューティングに役立ちます。
8.1 ロギングの構成
ロギング・レベルごとの範囲の指定など、ロギングを処理する様々な方法を構成できます。
- ロギングの構成について
RESTfulサービスのロギング構成を使用すると、発生の可能性がある問題のトラブルシューティングに役立つ診断ロギング情報を生成できます。 - ログ・プロパティ・ファイルのパラメータ
ログ・プロパティ・ファイルには、ハンドラ、ログ・レベル、出力ファイル名などの側面を制御するためのパラメータがあります。 - 例:ロギング・ファイル
Oracle Key Vault RESTfulサービスのロギング・ファイルは、Javaロギング・ユーティリティのjava.util.loggingに基づいています。
親トピック: ロギング、エラー・レポートおよびヘルプ情報
8.1.1 ロギングの構成について
RESTfulサービスのロギング構成を使用すると、発生の可能性がある問題のトラブルシューティングに役立つ診断ロギング情報を生成できます。
Oracle Key Vault RESTfulサービスのロギングは、カスタマイズされたJavaロギング・ユーティリティjava.util.loggingに基づいています。
RESTfulサービスのロギング構成は、ログ・プロパティ・ファイルで指定します。ログ・プロパティ・ファイルでは、次のことが可能です。
- ログ・メッセージの送信先をコンソールにするか、ファイルにするか、その両方にするかを指定します
- ログ・メッセージを書き込むファイルの名前を指定します
- ログ・メッセージの詳細のレベルを指定します。
- 使用するログ・フォーマッタを指定します。XML形式または通常のテキスト形式を選択できます。各ログ・エントリには、そのログ・エントリが生成された時刻とともにクラス、オブジェクトおよびメソッドが表示されます。
Oracle Key Vault RESTfulサービスの構成ファイル(okvrestcli.ini)でログ・プロパティ・ファイルを指定するには、log_propertyパラメータを使用します。
親トピック: ロギングの構成
8.1.2 ログ・プロパティ・ファイルのパラメータ
ログ・プロパティ・ファイルには、ハンドラ、ログ・レベル、出力ファイル名などの側面を制御するためのパラメータがあります。
表8-1に、Oracle Key Vault RESTfulロギング・プロパティ・ファイルのパラメータを示します。
表8-1 ログ・プロパティ・ファイルのパラメータ
| ロギング・プロパティ | 説明 |
|---|---|
|
|
ログ・メッセージを出力するハンドラ・クラスのカンマ区切りリスト。使用可能なハンドラは、
Handlersには、 |
|
|
すべての
|
|
|
これらの |
|
|
出力ファイル名の生成パターンを指定します。パターンは、実行時に置換される次の特別な構成要素を含む文字列で構成されます。
|
|
|
ファイルの最大サイズ(バイト単位)。0の場合は、無制限になります。デフォルトは200000です。指定の制限より大きいログは、次のログ・ファイルにロールオーバーされます。 |
|
|
ログ・ファイルのローテーションに使用するログ・ファイルの数。デフォルトは5です。 |
|
|
使用する XML形式でログ・エントリを生成するには、 プレーン・テキストでログ・エントリを生成するには、 |
|
|
すべての これらのレベルの詳細は、 |
|
|
使用する XML形式でログ・エントリを生成するには、 プレーン・テキストでログ・エントリを生成するには、 |
親トピック: ロギングの構成
8.1.3 例: ロギング・ファイル
Oracle Key Vault RESTfulサービスのロギング・ファイルは、Javaロギング・ユーティリティのjava.util.loggingに基づいています。
例8-1に、INFOロギング・レベルを使用するロギング・ファイルを示します。
例8-1 ロギング・ファイル
handlers= java.util.logging.FileHandler
.level=INFO
# default file output is in log directory.
java.util.logging.FileHandler.pattern = ./conf/okvrestcli.log
java.util.logging.FileHandler.limit = 200000
java.util.logging.FileHandler.count = 4
java.util.logging.FileHandler.level = INFO
java.util.logging.FileHandler.formatter = com.oracle.okv.rest.log.OkvFormatter
親トピック: ロギングの構成
8.2 エラー・レポート
RESTfulサービス・ユーティリティには、RESTfulサービス・コマンドをすばやく正常に実行するためにデバッグする強力なエラー・レポートがあります。
- エラー・レポートについて
ロギング構成によっては、障害に関する追加情報がOracle Key Vaultによってログ・ファイルに書き込まれる場合があります。 - コマンドラインのエラー・レポート
エラー・レポートでは、不正なパスワードなどの問題があったアクションおよび正常なコマンド実行の両方が取得されます。
親トピック: ロギング、エラー・レポートおよびヘルプ情報
8.2.1 エラー・レポートについて
ロギング構成によっては、障害に関する追加情報がOracle Key Vaultによってログ・ファイルに書き込まれる場合があります。
修正処理の提案とともに具体的なエラーが報告されます。エラー・レポートは、すべてのRESTコマンドに共通です。
コマンドの失敗について調べるときには、まずログ・ファイルを調べます。選択した場所にカスタム・ログ・ファイルを作成していない場合は、confディレクトリ内にあるデフォルトのログ・ファイルokvrestcli.logを調べます。
コマンド実行中のOracle Key Vaultサーバーからのすべてのメッセージを表示するには、構成ファイルで適切なロギング・レベル、ログ・ファイル名およびログ・ファイルの場所を設定できます。
RESTfulサービス・ユーティリティは、ファイルやJAVA_HOMEなどの環境変数が見つからない、不正なコマンド構文、不正なパスワードなどのエラーを報告します。
親トピック: エラー・レポート
8.2.2 コマンドラインのエラー・レポート
エラー・レポートでは、不正なパスワードなどの問題があったアクションおよび正常なコマンド実行の両方が取得されます。
例: エラー: 不正なパスワード
okv admin endpoint update --user pfitch --endpoint hr_db_ep --description 'HR DB Endpoint'
Password: password
{
"result" : "Failure",
"message" : "Invalid username or password. Try again after 5 seconds."
}例: 正常なサービス・コマンドの実行
okv admin endpoint update --user pfitch -endpoint hr_db_ep --description 'HR DB Endpoint'
Password: password
{
"result" : "Success"
}例: ログ・ファイルのエントリ
有用なエラー・メッセージおよび使用に関するメッセージに加え、ログ・ファイルには、アクションのエントリが日付とともに記録されます。
Thu Oct 29 15:50:19 PDT 2020::com.oracle.okv.rest.cli.okv::main::1::[backup, history, list, --max, 5] Thu Oct 29 15:50:19 PDT 2020::com.oracle.okv.rest.cli.backup.BackupProcessManager::<init>::1::https://10.240.112.193:5695/okv/cloud/api Thu Oct 29 15:50:19 PDT 2020::com.oracle.okv.rest.cli.backup.BackupProcessManager::<init>::1::/scratch/dopark/demo/EP1/ssl Thu Oct 29 15:50:19 PDT 2020::com.oracle.okv.rest.cli.backup.BackupOptionsProcessor::takeOption::1::BackupOptionBean [name=null, startTime=null, destination=null, type=null, max=5, interval=null, passphrase=null, transferMethod=null, hostName=null, port=null, path=null, userName=null, authenticationMethod=null, psd=null, cluster=false]
親トピック: エラー・レポート
8.3 ヘルプ情報
RESTfulサービス・ユーティリティが提供する有効なオプションに関する情報が見つかります。
有効なオプションのリストを表示するには、okv --helpコマンドを実行します。次に例を示します。
okv --help
Oracle Key Vault REST CLI Version 21.1.0.0.0 Built 11/25/2020 12:56
usage: okv <category> <resource> <action> [--option]
--client_wallet <arg> Client wallet
--config <arg> OKV REST CLI configuration
file(okvrestcli.ini) location
--from-json <arg> Input file in JSON
--generate-json-input Generate template file in JSON
--help List available options
--okv_client_config <arg> OKV Client configuration
file(okvclient.ora) location
--password <arg> Password
--profile <arg> Profile name in configuration
file(okvrestcli.ini)
--server <arg> OKV server IP address or hostname
--user <arg> Usernameコマンドでサポートされているオプションの詳細を調べるには、--generate-json-input句を指定してコマンドを実行します。出力には、そのコマンドでサポートされるコマンドライン・オプションが含まれています。たとえば、--generate-json-input句を使用してokv admin endpoint createコマンドを実行するとします。
okv admin endpoint create --generate-json-input出力には、エンドポイントの作成時に使用できるオプションが示されます。この場合、そのオプションはendpoint、description、email、platform、type、subgroupおよびuniqueになります。
{
"service" : {
"category" : "admin",
"resource" : "endpoint",
"action" : "create",
"options" : {
"endpoint" : "#VALUE",
"description" : "#VALUE",
"email" : "#VALUE",
"platform" : "#LINUX64|SOLARIS64|SOLARIS_SPARC|HP-UX|AIX|WINDOWS",
"type" : "#ORACLE_DB|ORACLE_NON_DB|ORACLE_ACFS|MYSQL_DB|OTHER",
"subgroup" : "#VALUE|NO SUBGROUP|USE CREATOR SUBGROUP",
"unique" : "#TRUE|FALSE"
}
}
}親トピック: ロギング、エラー・レポートおよびヘルプ情報