IBM Cloud Logs Routing CLI

IBM Cloud® コマンド・ライン・インターフェース (CLI) には、サービス・オファリングのための追加機能が用意されています。この情報では、CLI を使用して IBM Cloud Logs Routing サービスを定義および管理する方法について説明します。

開始前に

以下のステップを実行します。

IBM Cloud CLI をインストールします。
IBM Cloud Logs Routing CLIをインストールして設定する。

IBM Cloud CLI およびプラグインに対する更新が使用可能になると、コマンド・ラインで通知されます。最新のコマンドを使用できるよう、CLIは常に最新の状態にしておいてください。 ibmcloud plugin list を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。

ibmcloud logs-router route create

このコマンドを使用して、1つ以上のリージョンからアカウント内の IBM Cloud Logs Routing ターゲットへのデータのルーティング方法を定義するルートを作成する。ルートは、作成されたアカウント管理することも、企業のアカウント管理することもできます。

ターゲットは IBM Cloud Logs インスタンスでなければならない。

ibmcloud logs-router route create --name ROUTE_NAME ( --rules RULES | @RULES-FILE) [--managed-by MANAGED-BY] [--output FORMAT]

コマンド・オプション

--name ROUTE_NAME

経路に付ける名前。

最大文字数は1000文字です。最小長は1文字です。

名前に (space) - . _ : 以外の特殊文字を含めることはできません。

リソース名に個人識別情報 (PII) を含めないでください。

--rules RULES | @RULES-FILE

設定された順序で評価されるルーティングルール。

シングルクォーテーションで囲まれたJSON文字列、またはJSONファイルへのパスを設定する必要があります。

最大長は10ルール。最小の長さは1ルールである。

例えば、以下のようにJSON文字列を設定するか、@filepathを使ってjsonを渡すことができる：

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de"]}]}]'

JSONファイルを以下のようにフォーマットすると、すべてのデータをルールで設定されたターゲットにルーティングすることができる：

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"}]
  }
]

ルール定義には、オプションで包含フィルタを含めることができる。 JSONファイルは以下のようにフォーマットできる：

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de"
          ]
        }
    ]
 }]

ここで、

action

Actionは、 IBM Cloud Logs Routing、ルート上のログを含めるか除外するかを定義します。 send と drop の2つのアクションがサポートされている。指定されない場合、デフォルトの動作はログを送信することである。

send: ログはルーティングルールに基づき、定義されたルートで送信される。
drop: ログが定義されたルートで送信されると、ルーティングルールに基づいてログが除外されます。

targets

ターゲットは、ログがルーティングされる IBM Cloud Logs 宛先を定義する。コンマで区切られたターゲットIDのリストである。

inclusion_filters

インクルード・フィルターは、どのデータがルーティングされるかを定義する。

コンマで区切られたフィルターのリストを設定することができます。

フィルタは、オペランド、演算子、値によって定義される。

ルールごとに最大7つのフィルターを定義できる。

operand

オペランドは、 operator が実行されるプロパティの名前である。

有効なオペランドは以下の通り： location.

operator

in と is の2つの演算子がサポートされている。

in

オペランド・プロパティの値は、値のリストと比較されます。

最大20個の値を定義できる。

is

オペランド・プロパティの値は、単一の値と比較される。

is を使用する場合、指定できる値は1つだけである。

values

ログがルーティングされるかどうかを決定するために、 operand プロパティと比較される文字列、または文字列の配列。

is operator を使用する場合、 values には文字列を1つ含めなければならない。

in operator 、 values は複数の文字列を配列に含めることができる。

--managed-by

ルートがどのように管理されているかを示す。

ルートは、デフォルト値 account を設定することで、作成されたアカウントローカルに管理することができます。また、値 enterprise を設定することで、エンタープライズアカウント管理することもできます。

有効な値は enterprise または account。

デフォルト値は「アカウント」である。

ルート作成後にこの値を変更することはできません。

--output FORMAT

JSON が指定された場合、出力はJSON形式で返される。 JSON が指定されない場合、出力は表形式で返される。

help | --help | -h

コマンドで使用できるオプションがリストされます。

ibmcloud logs-router route update

このコマンドを使用して、1つまたは複数のリージョンからアカウント内の IBM Cloud Logs Routing ターゲットへのデータのルーティング方法を定義するルートを更新する。

ルートが最初に作成されたときと異なる指定された値は、コマンドで指定された値に更新される。以前にデプロイされ、アップデート要求に含まれていない構成はすべて削除される。

ibmcloud logs-router route update --route ROUTE [--name NAME] [--rules RULES | @RULES-FILE]

コマンド・オプション

--route ROUTE

経路の ID または名前。

IDはルートを一意に識別する v4 UUIDである。

IDの最大長は1028文字。 IDの最小文字数は24文字である。

--name NAME

ルートにつけられる新しい名前（オプション）。

リソース名に個人識別情報 (PII) を含めないでください。

--rules RULES | @RULES-FILE

設定された順序で評価されるルーティングルール。

シングルクォーテーションで囲まれたJSON文字列、またはJSONファイルへのパスを設定する必要があります。

最大長は10ルール。最小の長さは1ルールである。

現在のコンフィギュレーションを維持しつつ、必要な修正を加える。更新に含まれていない既存のルール構成はすべて削除される。

例えば、JSON形式のルール定義のサンプルを参照するか、@filepathを使ってjsonを渡す：

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de","eu-gb"]}]}]'

JSONファイルを以下のようにフォーマットすると、すべてのデータをルールで設定されたターゲットにルーティングすることができる：

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"},{"id":"ID3"}]
  }
]

ルール定義には、オプションで包含フィルタを含めることができる。 JSONファイルは以下のようにフォーマットできる：

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de",
            "eu-gb"
          ]
        }
    ]
 }]

action

send: ログはルーティングルールに基づき、定義されたルートで送信される。
drop: ログが定義されたルートで送信されると、ルーティングルールに基づいてログが除外されます。

targets

ターゲットは、ログがルーティングされる IBM Cloud Logs 宛先を定義する。コンマで区切られたターゲットIDのリストである。

inclusion_filters

インクルード・フィルターは、どのデータがルーティングされるかを定義する。

コンマで区切られたフィルターのリストを設定することができます。

フィルタは、オペランド、演算子、値によって定義される。

ルールごとに最大7つのフィルターを定義できる。

operand

オペランドは、 operator が実行されるプロパティの名前である。

有効なオペランドは以下の通り： location.

operator

in と is の2つの演算子がサポートされている。

in

オペランド・プロパティの値は、値のリストと比較されます。

最大20個の値を定義できる。

is

オペランド・プロパティの値は、単一の値と比較される。

is を使用する場合、指定できる値は1つだけである。

values

ログがルーティングされるかどうかを決定するために、 operand プロパティと比較される文字列、または文字列の配列。

is operator を使用する場合、 values には文字列を1つ含めなければならない。

in operator 、 values は複数の文字列を配列に含めることができる。

--output FORMAT

JSON が指定された場合、出力はJSON形式で返される。 JSON が指定されない場合、出力は表形式で返される。

help | --help | -h

コマンドで使用できるオプションがリストされます。

ibmcloud logs-router route delete

IBM Cloud Logs Routing ルートを削除するには、このコマンドを使用します。

ibmcloud logs-router route delete --route ROUTE

コマンド・オプション

--route ROUTE: 削除するルートのIDまたは名前。
--forceまたは--f: ユーザーに追加のプロンプトを表示せずにルートを削除します。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloud logs-router route get

IBM Cloud Logs Routing ルートに関する設定情報を取得するには、このコマンドを使用します。

ibmcloud logs-router route get --route ROUTE

コマンド・オプション

--route ROUTE: 経路の ID または名前。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloud logs-router ルートリスト

このコマンドを使用して、アカウント内の IBM Cloud Logs Routing に設定されたすべてのルートを一覧表示します。

ibmcloud logs-router route list

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloud logs-router target create

このコマンドを使用して、プラットフォーム・メトリクスの宛先構成に使用するターゲットを作成します。すべてのリージョンからのプラットフォームログを、単一のターゲット、異なるターゲット、または複数のターゲットに送信することができます。各地域に1つの目標は必要ない。アカウントごとに最大16のターゲットを定義できる。

ターゲットは IBM Cloud Logs インスタンスでなければならない。

ibmcloud logs-router target create --name NAME --destination-crn DESTINATION-CRN [--region REGION] [--managed-by MANAGED-BY]

コマンド・オプション

--region REGION

リージョンの名前 (us-south や eu-gb など)。指定がない場合は、ログインしている、またはターゲットとしているリージョンが使用される。これはオプションです。

--name NAME

ターゲットに付ける名前。

リソース名に個人識別情報 (PII) を含めないでください。

--destination-crn DESTINATION-CRN

IBM Cloud Logs Routing によって送信されたログを受信するサービスインスタンスまたはリソースの CRN。 IBM Cloud Logs Routing と IBM Cloud リソースの間でサービス認可があることを確認してください。詳細については、「サービス間のアクセスを許可する権限の管理」を参照してください。

[--managed-by MANAGED-BY] これはオプションです。このターゲットの管理者を特定する。作成時のオプション。 enterprise'に設定すると、ターゲットはエンタープライズ管理され、エンタープライズのアクションを許可されたIDのみが変更できるようになります。省略またはアカウント 'に設定された場合、ターゲットはアカウント管理される。この値は作成後も不変である。使用可能な値は、enterprise、アカウントです。

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudログ・ルーター・ターゲット更新

このコマンドを使用して、プラットフォーム・メトリクスの宛先構成に使用するターゲットを更新します。

ターゲットは IBM Cloud Logs インスタンスでなければならない。

ibmcloud logs-router target update --target TARGET [--name NAME] [--destination-crn DESTINATION-CRN]

コマンド・オプション

--target TARGET ターゲットの ID または名前。

--name NAME

ターゲットに与えられる新しい名前。

リソース名に個人識別情報 (PII) を含めないでください。

--destination-crn DESTINATION_CRN

help | --help | -h

コマンドで使用できるオプションがリストされます。

ibmcloudログ・ルーター・ターゲット削除

このコマンドは、ターゲットを削除するために使用します。

ibmcloud logs-router target delete --target TARGET

コマンド・オプション

--target TARGET: ターゲットの ID または名前。
--force | -f: ユーザーに追加のプロンプトを表示することなく、ターゲットを削除する。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloud logs-router target get

IBM Cloud Logs Routing ターゲットに関する情報を取得するには、このコマンドを使用する。

ibmcloud logs-router target get --target TARGET

コマンド・オプション

--target TARGET: ターゲットの ID または名前。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudログ・ルーター・ターゲット・リスト

このコマンドを使用して、 IBM Cloud Logs Routing に設定されているすべてのターゲットを一覧表示します。

ibmcloud logs-router target list

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudログルーター設定取得

このコマンドを使用して、 IBM Cloud Logs Routing アカウントレベルのコンフィギュレーションの設定を取得する。

ibmcloud logs-router setting get

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudのログ・ルーター設定の更新

このコマンドを使用して、 IBM Cloud Logs Routing のデフォルトターゲット、許可されたターゲット領域、プライマリおよびセカンダリメタデータ領域などの現在の設定を変更する。ターゲットが最初に作成されたときと異なる値は、コマンドで指定された値に更新される。オプションが指定されていない場合は、現在の設定が返される。

--private-api-endpoint-only TRUEを設定してパブリック・エンドポイントを無効にする前に、アカウントにプライベート・エンドポイントへのアクセス権限があることを確認してください。これを行うには、コマンドibmcloud account showを実行します。 VRF Enabledが true で、Service Endpoint Enabledが true の場合は、プライベート・エンドポイントへのアクセス権限があります。プライベート・エンドポイントにアクセスできなければ、パブリック・エンドポイントを有効にすることはできない。パブリック・エンドポイントを有効にするには、プライベート・エンドポイントへのアクセスが必要である。

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY]

コマンド・オプション

--api-version: IBM Cloud アカウント IBM Cloud Logs Routing サービスの API バージョン。有効な値は1と3。デフォルト値は 1 です。 V1 で有効なターゲットとテナントを作成した場合のみ、1 から 3 に更新してサービス構成を移行できます。一度このアップデートを行うと、バージョン1に戻すオプションはない。詳細は https://ibm.biz/lr-v3migration を参照。
--backup-metadata-region: IBM Cloud Logs Routing メタデータのバックアップに使用されるバックアップ領域。最大長は 256 文字です。最小文字数は3文字です。
--default-targets: IBM Cloud アカウントルーティングルールで明示的に管理されていないログを受信するターゲット。ターゲットは2つまで定義できる。ターゲットの最小数は0。
--permitted-target-regions: IBM Cloud Logs Routing、ユーザーがアカウントターゲットを作成できる地域をカンマ区切りで列挙。詳細は https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations を参照。最大長は16リージョン。最小の長さは0リージョンである。
--primary-metadata-region: IBM Cloud Logs Routing メタデータのバックアップに使用されるプライマリ領域。最大長は 256 文字です。最小文字数は3文字です。
--private-api-endpoint-only: エンドポイント接続に対応。この値を "false "に設定すると、パブリック・ネットワーク経由でAPIにアクセスできる。この値を "true "に設定すると、プライベート・ネットワーク経由でのみAPIにアクセスできるようになる。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudログ・ルーター移行完了

バージョン1からバージョン3への移行ログを完了するには、このコマンドを使用します。このコマンドを使用するには、移行ステータスがPENDING_COMPLETIONでなければなりません。

ibmcloud logs-router migrate complete

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudログ・ルーター・マイグレーションの生成

このコマンドを使用して、バージョン1からバージョン3へのログルーティングの非同期マイグレーションを開始する。このコマンドを使用するには、移行ステータスがBEFOREでなければならない。

ibmcloud logs-router migrate generate

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloud logs-router migrate delete

このコマンドを使用して、すべてのログルーティングバージョン3のルートとターゲットを削除し、移行ステータスをBEFOREにリセットします。状態がPENDING_COMPLETIONまたはBEFOREのときのみ許可される。

ibmcloud logs-router migrate delete

コマンド・オプション

--force|-f`: 確認なしで操作を削除する。
help | --help | -h: コマンドで使用できるオプションがリストされます。

ibmcloudのログ-ルーターのマイグレートステータス

このコマンドを使用して、ステータスログのルーティング移行の状態とバージョン情報を取得します。可能な状態は以下のとおりである：COMPLETE、BEFORE、IN_PROGRESS、PENDING_COMPLETIONである。

ibmcloud logs-router migrate status

コマンド・オプション

help | --help | -h: コマンドで使用できるオプションがリストされます。