IBM Cloud Logsインスタンスにデータを送信するプラグインパラメータを出力する

ロギング・エージェント の IBM Cloud Logs インスタンスにデータを送信する出力プラグインの設定に使用できるパラメータのリスト。

FluentBitパラメーター

Fluentbitパラメータ
キー 説明 デフォルト 価値ある選択 必須
Name プラグインの名前。 logger-icl-output-plugin に設定されていなければならない 該当しない logger-icl-output-plugin はい
Id プラグインの固有ID。 該当しない 任意のストリング はい
Match イベントのマッチング方法を指定する。 該当しない 任意のストリング はい
Retry_Limit プラグインがCloud Logsへのデータ送信に失敗した場合、処理を再試行する。
永遠に再試行したい場合は False を、そうでない場合は整数値を設定する。
リトライの設定方法の詳細については、 こちらを参照してください		 1 False または N >= 1 はい
Workers IBM Cloud Logsに送信する同時ワーカースレッド数
IBM Cloud Logsに送信されるログのスループットを上げるために、各エージェントから送信される同時スレッド数を増やすことができます。
詳細情報		 1 1 つ以上 false

接続パラメーター

接続パラメーター
キー 説明 デフォルト 価値ある選択 必須
Target_Host 接続に使用するインジェストホスト名 該当しない 任意のurlエンドポイント はい
Target_Port 接続に使用するインジェスト・ポート 443 任意のポート番号 false
Target_Path 接続に使用する URL /logs/v1/singles 任意のストリング false

ロギング・パラメーター

ロギング・パラメーター
キー 説明 デフォルト 価値ある選択 必須
Logging_Level プラグインで使用するログレベルを指定する info debug
info
error		 false
Package_Size パッケージサイズをKBまたはMBで指定 2 例えば、2MB、10KB のように、数字の後に単位が続くもの。2MB より小さくなければならない false

認証パラメーター

認証パラメーター
キー 説明 デフォルト 価値ある選択 必須
Authentication_Mode 認証モードを指定する TrustedProfile TrustedProfile
IAMAPIKey		 false
IAM_Environment 認証のためのIAM環境を指定する Production Production はパブリック・エンドポイント 'iam.cloud.ibm.com'

'PrivateProduction はプライベート・エンドポイント 'private.iam.cloud.ibm.com'

'Custom IAM_Host を指定する。

 false
IAM_Host カスタムIAM環境のIAMホスト名 該当しない 完全修飾 IAM ホスト名（例：'private.eu-de.iam.cloud.ibm.com IAM_Environment が 'Custom に設定されている場合にのみ使用される。
CR_Token_Mount_Path CRTokenが存在するパス /var/run/secrets/tokens/vault-token 任意のストリング false - Authentication_Mode が TrustedProfile に設定されている場合のみ使用されます
Trusted_Profile_ID 使用する信頼プロファイルのID 該当しない 任意のストリング true - Authentication_Mode が TrustedProfile に設定されている場合のみ使用されます
IAM_API_key 使用するapiキー。apiキーの指定についての詳細は、以下の注記を参照のこと 該当しない 任意のストリング false

Authentication_Mode が IAMAPIKey に設定されている場合、apiキーは3つの方法のいずれかで指定しなければならない。 これらの優先順位は以下の通り：

  1. コンフィグ内の IAM_API_key
    • 設定ファイルに直接apiキーを挿入しないことを強く推奨する。 その代わりに、 ${CUSTOM_ENVIRONMENT_VARIABLE} という形式の値を使って、以下に挙げる以外の環境変数を取り出すことができる
  2. という環境変数を使う。 IAM_API_KEY_<output_ID>
    • ここで、 <output_ID> は、 Id パラメーターで指定された出力プラグインに与えられたIDで、ダッシュ（- ）はアンダースコア（_ ）に置き換えられます
  3. という環境変数を使う。 IAM_API_KEY

上記のオプションのどれにも値が与えられていない場合、プラグインの初期化は失敗する。

Fluentbit Agent Workers の設定に関する考慮事項

worker は、ロギング・エージェント のコンテキストでは、ロギング・エージェントがログを処理するために利用可能な CPU スレッドを表す。

出力プラグインの設定で利用可能なワーカーの数を設定できます。

  • fluent-bitのデフォルト設定では、'Workers=1 がデフォルト設定であり、これは1MB/sec未満のログボリュームを生成するワークロードに対して機能する。
  • ロギング量が1MB/秒を超えるような環境では、出力プラグインが消費されるログを処理できるように、「Workers コンフィギュレーションを増やす必要があるかもしれない。
  • Openshift と Kubernetes デプロイメント用のHelmチャートは、一般的にほとんどのKubernetesワークロードに適した設定であるため、4 ワーカーで構成されています。

Helm チャートを使用している場合は、 outputWorkers Helm 変数を使用して、出力プラグインの Workers 設定を管理する。

あなたの環境で'Workers 値を設定する際の注意点をいくつか挙げておこう：

  • ワーカーの数を4から2に減らすことで、ロギング・エージェントのCPU要件を減らすことができるかもしれません。

  • Kubernetes環境でCPUの上限を増やさずにワーカーの数を4以上に増やしても、ロギング・エージェントで処理されるログが増えることは通常ありません。 CPUがスループットを制限し、同様に増やさなければならないポイントがある。

  • もし、ロギング・エージェントのログに「[input] pausing tail 後に「[input] resume tail 続くメッセージが表示された場合、ログを送信している出力プラグインが、生成されるログの量に追いついていないことを示しています。 CPU使用率が定義されたCPU制限に達していない場合、ワーカー数を増やせば通常はスループットが向上する。 CPU使用率が限界に近い場合は、ワーカー数を増やすだけでなく、CPUの上限を増やす必要があります。 1時間に数回「[input] pausing tail メッセージが発せられても構わない。 このメッセージが1分間に何度も表示される場合は、設定の変更を検討する必要があります。

  • [ warn] [input:tail:tail.0] purged rotated file while data ingestion is paused, consider increasing rotate_wait メッセージが表示された場合、これは通常、入力量がエージェントの処理能力を大幅に上回っていることを示しています。 ワーカー数またはCPU数（またはその両方）を増やさないと、ファイルローテーションのためにローテーションされたファイルが処理されなくなり、取り込みが一時停止されるため、ログが欠落することになる。 このエラーが発生する場合は、ワーカーかCPUの制限（またはその両方）を増やす必要があります。