ロギング (ibmcloud ロギング) CLI
IBM Cloud® コマンド・ライン・インターフェース (CLI) には、サービス・オファリングのための追加機能が用意されています。 この情報は、CLI を使用してアカウントの IBM Log Analysis サービス・インスタンスの情報をリスト表示したりエクスポートしたりする方法について説明します。
サポート終了:2025年3月30日をもって、 IBM Log Analysis と IBM Cloud Activity Tracker のサービスはサポート終了となりました。 IBM Cloud Logs がこの2つのサービスに取って代わります。 IBM Cloud Logs については、IBM Cloud Logs ドキュメント を参照してください。
UI を使用したエクスポートは、V1 エクスポート API を使用し、そのバージョンの API によって提供される機能に限定されます。
前提条件
-
IBM Cloud CLI をインストールします。
-
以下のコマンドを実行して、ロギング CLI をインストールします。
ibmcloud plugin install logging
IBM Cloud CLI およびプラグインに対する更新が使用可能になると、コマンド・ラインで通知されます。 最新のコマンドを使用できるように、CLI をいつも最新の状態にしておいてください。 ibmcloud plugin list
を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。
ibmcloud logging service-instances
このコマンドを使用して、IBM Log Analysis のサービス・インスタンスをリストします。
ibmcloud logging service-instances [OPTIONS]
コマンド・オプション
--service-name <NAME>
|--sn <NAME>
-
サービスの名前。
--region <NAME>
|-r <NAME>
-
リージョンの名前 (
us-south
やeu-gb
など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。 --all-regions
-
すべてのリージョンでホストされているサービス。
-g <GROUP>
-
ホスト・サービスに関連付けられたリソース・グループ。
--all-resource-groups
-
すべてのリソース・グループでホストされているサービス。
--quiet
|-q
-
詳細出力を抑制します。
--output <TYPE>
-
二重引用符 (") で囲まれた出力設定のコンマ区切りリスト。指定する設定が 1 つのみの場合、二重引用符は省略できます。 サポートされているオプションは、
WIDE
とJSON
です。JSON
を指定すると、出力が JSON 形式で返されます。JSON
を指定しない場合は、出力が表形式で返されます。WIDE
の場合は、出力として追加の詳細情報が返されます。 --help
|-h
-
コマンドで使用できるオプションがリストされます。
例
以下に、ibmcloud logging service-instances
コマンドを使用する例を示します。
ロギング・サービスのすべてのインスタンスをリストします。
ibmcloud logging service-instances
test-rg
リソース・グループにあるすべてのインスタンスを表示します。
ibmcloud logging service-instances -g test-rg
すべてのインスタンスを表示し、追加の詳細情報 (ID、GUID、リソース ID など) を含めます。
ibmcloud logging service-instances --output wide
すべてのインスタンスを表示し、最小限の詳細情報 (名前、リージョン、状態) のみを含めます。
ibmcloud logging service-instances --quiet
us-south
リージョンのすべてのインスタンスを表示します。
ibmcloud logging service-instances --region us-south
us-south
リージョンのすべてのインスタンスをリストし、出力を JSON 形式で返します。
ibmcloud logging service-instances --region us-south --output json
ibmcloud ロギングのエクスポート
このコマンドを使用して、ログ情報をエクスポートします。 エクスポートしたログ情報をフィルタリングするためのオプションがあります。 エクスポートした情報はコマンドに対する応答として表示されます。オプションで、コマンドで指定した E メール・アドレスに送信されるリンクからアクセスするようにもできます。
ibmcloud logging export --service-key <SERVICE_KEY> [OPTIONS]
コマンド・オプション
--service-key <SERVICE_KEY>
|-s <SERVICE_KEY>
- (必須) インスタンスのサービス・キー。
--region <REGION>
|-r <REGION>
- リージョンの名前 (
us-south
やeu-gb
など)。 指定しない場合は、ログインしているリージョンまたはターゲットになっているリージョンが使用されます。 --hosts <HOST_NAMES>
|--ho <HOST_NAMES>
- 二重引用符 (") で囲まれたホスト名のコンマ区切りリスト。ホスト名を 1 つのみ指定する場合は、二重引用符を省略できます。 指定されたホスト名のログ項目が返されます。
--apps <APP_NAMES>
|-a <APP_NAMES>
- 二重引用符 (") で囲まれたアプリ名のコンマ区切りリスト。アプリ名を 1 つのみ指定する場合は、二重引用符を省略できます。 指定されたアプリのログ項目が返されます。
--levels <LOG_LEVELS>
|-l <LOG_LEVELS>
- 二重引用符 (") で囲まれたログ・レベル値のコンマ区切りリスト。レベルを 1 つのみ指定する場合は、二重引用符を省略できます。 指定されたレベルのログ項目が返されます。 環境に応じて、指定できるログ・レベルは、CRITICAL、DEBUG、EMERGENCY、ERROR、FATAL、INFO、SEVERE、TRACE、WARN、または ALERT です。
--number <NUMBER>
|-n <NUMBER>
- エクスポートするログ項目の総数。
--from <TIME>
- ログ項目で使用する開始時刻。 この時刻より前のログ項目は返されません。
<TIME>
は、UNIX タイム・スタンプとして秒またはミリ秒単位で指定されます。 --to <TIME>
- ログ項目で使用する終了時刻。 この時刻より後のログ項目は返されません。
<TIME>
は、UNIX タイム・スタンプとして秒またはミリ秒単位で指定されます。 --output <TYPE>
- 作成される出力のタイプ。
JSON
を指定すると、出力が JSON 形式で返されます。 指定されない場合、出力は表形式で返されます。 --query <STRING>
|-q <STRING>
- ログ内で検索する値。 指定された
<STRING>
を含むすべてのログ項目が返されます。 --prefer <VALUE>
|-p <VALUE>
- エクスポートするログの行。 有効な値は、
HEAD
およびTAIL
です。HEAD
は、ログの行を、最も古い項目から最新の項目への順序でエクスポートすることを指定します。TAIL
は、ログの行を、最新の項目から最も古い項目への逆の順序でエクスポートすることを指定します。 指定しない場合、デフォルトはTAIL
です。 --email <ADDRESS>
|-e <ADDRESS>
- 指定した場合、エクスポート情報へのリンクが含まれる E メールが、指定した E メール
<ADDRESS>
に送信されます。 受信者は、そのリンクを使用して、エクスポートされた情報をダウンロードできます。 --email-subject <SUBJECT>
|--es <SUBJECT>
--email
と同時に使用して、送信される E メールに組み込む件名を指定します。--help
|-h
- コマンドで使用できるオプションがリストされます。
例
以下に、ibmcloud logging export
コマンドを使用する例を示します。
指定したサービス・キーのすべてのログをエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY>
指定したサービス・キーの、指定した時刻範囲で発生するログ項目をエクスポートします。 タイム・スタンプは UNIX 形式にする必要があります。 例: 1614228407550
ibmcloud logging export --service-key <SERVICE_KEY> --to <END_TIME> --from <START_TIME>
指定したサービス・キーの INFO
レベルおよび ERROR
レベルのログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --levels "INFO,ERROR"
指定したサービス・キーの metric-server
アプリおよび myapp
アプリのログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --apps "metrics-server,myapp"
指定したサービス・キーの test-hostname
および cloudantnosqldb
の各ホストのログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --hosts "test-hostname,cloudantnosqldb"
指定したサービス・キーの eu-gb
リージョンのログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --region eu-gb
指定したサービス・キーの、ストリング "new line" が含まれるログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --query "new line"
指定したサービス・キーの、ストリング "new line" がログの 1 行目 (head
) に含まれるログ項目をエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --query "new line" --prefer head
指定したサービス・キーの、myapp
アプリのログ項目を JSON 形式でエクスポートします。
ibmcloud logging export --service-key <SERVICE_KEY> --apps myapp --output json
件名が「Emailing myapp logs」で、ダウンロード可能なリンクが含まれる E メールを myemail@mycompany.com
に送信します。 この例では、myemail@mycompany.com
はリンクから 、コマンド実行時に指定したサービス・キーの myapp
アプリのすべてのログ項目のリストを表示できます。
ibmcloud logging export --service-key <SERVICE_KEY> --apps myapp --email myemail@mycompany.com --email-subject "Emailing myapp logs"