すべてのプロダクト
Search

このプロダクト

    Simple Log Service:AliyunPipelineConfig パラメーター

    ドキュメントセンター

    Simple Log Service:AliyunPipelineConfig パラメーター

    最終更新日:Oct 11, 2025

    このトピックでは、ClusterAliyunPipelineConfig を使用してログ収集ルールを定義するための YAML ファイルの構造とフィールドについて説明します。

    仕組み

    1. CustomResource (CR) の作成: ClusterAliyunPipelineConfig YAML ファイルで収集ルールを定義し、kubectl を使用して送信します。

    2. コントローラーによる変更の監視: loongcollector-operator は、クラスター内の CR の変更を継続的に監視します。

    3. 構成の同期: CR の変更を検出すると、オペレーターはそれを Logtail 構成に変換し、指定されたプロジェクトに同期します。

    4. コレクターによる構成のプル: loongcollector-ds は、Simple Log Service (SLS) に定期的にハートビートを送信し、最新の収集構成をプルして、ホットリロードを通じて適用します。

    5. 収集とレポート: 新しい構成に基づいて、loongcollector-ds はログを収集し、構成されたエンドポイント経由で SLS に送信します。

    基本フィールド

    すべての構成は、次のように API バージョンとリソースタイプを定義することから始める必要があります。

    apiVersion: telemetry.alibabacloud.com/v1alpha1
kind: ClusterAliyunPipelineConfig

    構造例

    apiVersion: telemetry.alibabacloud.com/v1alpha1 # デフォルト値を使用します。変更しないでください。
kind: ClusterAliyunPipelineConfig               # デフォルト値を使用します。変更しないでください。
metadata:
  name: test-config                             # リソース名を設定します。現在の Kubernetes クラスター内で一意である必要があります。
spec:
  project:                                      # 宛先プロジェクトの名前を設定します。
    name: k8s-your-project                      
  config:                                       # Logtail 収集構成を設定します。
    inputs:                                     # Logtail 収集構成の入力プラグインを設定します。
      ...
    flushers:                                   # Logtail 収集構成の出力プラグインを設定します。
      ...

    コアパラメーターの説明

    metadata.name

    収集構成の名前。必須。プロジェクト内で一意である必要があり、作成後は変更できません。

    命名規則:

    • 小文字、数字、ハイフン (-)、アンダースコア (_) のみを含めることができます。

    • 小文字または数字で開始および終了する必要があります。

    • 2～128 文字である必要があります。

    例:

    metadata:
  name: nginx-access-log

    spec.project

    宛先プロジェクトを指定します。

    説明

    このフィールドは変更できません。プロジェクトを変更するには、新しい CR を作成する必要があります。

    パラメーター

    データの型

    必須

    説明

    name

    string

    はい

    宛先プロジェクトの名前。プロジェクトが存在しない場合は、自動的に作成されます。

    description

    string

    いいえ

    プロジェクトの説明。このパラメーターは、プロジェクトが作成されるときにのみ有効になります。

    endpoint

    string

    いいえ

    プロジェクトが配置されているリージョンの エンドポイント。デフォルト値はクラスターのリージョンです。

    • このパラメーターは、収集構成が作成されるリージョンのみを制御します。コレクターのデータ転送先は制御しません。

    • 詳細については、「config_server_address と data_server_list」をご参照ください。

    uid

    string

    いいえ

    宛先プロジェクトが属する Alibaba Cloud アカウントの UID。デフォルト値は、現在のクラスターが属する Alibaba Cloud アカウントの UID です。

    • このパラメーターは、収集構成が作成されるアカウントのみを制御します。

    • アカウントをまたいでログを収集するには、alibaba-log-controller コンポーネントの環境変数を構成します。

      ALICLOUD_LOG_ACCOUNT_INFOS={"<uid>":{"accessKeyID":"<your_access_key_id>","accessKeySecret":"<your_access_key_secret>"}}。

    spec.config

    入力、処理、出力プラグインを含む収集パイプラインを定義します。

    サブパラメーター

    タイプ

    必須

    説明

    sample

    string

    いいえ

    ログサンプル。複数のログがサポートされています。合計長は 1,500 バイトを超えることはできません。

    global

    object

    いいえ

    グローバル構成。

    inputs

    オブジェクトのリスト

    はい

    入力プラグインのリスト。現在、1 つの入力プラグインのみが許可されています。

    processors

    オブジェクトのリスト

    いいえ

    処理プラグインのリスト:

    flushers

    オブジェクトのリスト

    はい

    出力プラグインのリスト。現在、1 つの flusher_sls プラグインのみが許可されています。

    spec.logstores

    任意。自動的に作成される Logstore を宣言します。次の動作に注意してください。

    • 作成時にのみ有効: これらの設定は、新しい Logstore を作成する場合にのみ適用されます。Logstore が既に存在する場合、これらは無視されます。

    • データ宛先を決定しない: このリストは、ログの宛先 Logstore を制御しません。実際の宛先は、config.flushers の出力プラグイン (例: flusher_sls) によって決定されます。

    • 任意設定: 宛先 Logstore が既に存在する場合、ここで定義する必要はありません。

    • 追加/削除のみ: このリストから Logstore を追加または削除できますが、既存のものを変更することはできません。Logstore のプロパティ (ttl やシャード数など) を変更するには、SLS コンソールまたは API を使用します。

    パラメーター

    データの型

    必須

    説明

    name

    string

    はい

    作成する Logstore の名前。

    queryMode

    string

    いいえ

    Logstore タイプ。デフォルト値は standard です。有効な値:

    • query: クエリ Logstore。

    • standard: 標準 Logstore。

    ttl

    int

    いいえ

    日単位の データ保持期間。有効な値: 1～3650。デフォルト値は 30 です。3650 の値は永続的なストレージを示します。

    hotTtl

    int

    いいえ

    日単位の ホットデータストレージ期間。デフォルト値は 0 です。値は ttl 未満で、7 以上である必要があります。

    shardCount

    int

    いいえ

    シャードの数。デフォルト値は 2 です。有効な値: 1～100。

    maxSplitShard

    int

    いいえ

    自動的に分割できるシャードの最大数。デフォルト値は 64 です。有効な値: 1～256。

    autoSplit

    bool

    いいえ

    自動シャード分割を有効にするかどうかを指定します。デフォルト値は true です。

    telemetryType

    string

    いいえ

    観測可能なデータの型。デフォルト値は None です。有効な値:

    • None: ログデータ。

    • Metrics: メトリックデータ。

    appendMeta

    bool

    いいえ

    パブリック IP アドレスとログ受信時刻を記録するかどうかを指定します。デフォルト値は true です。

    • true: パブリック IP アドレスとログ受信時刻を記録する機能を有効にします。この機能が有効になると、SLS はソースデバイスのパブリック IP アドレスとログがサーバーに到着した時刻をログのタグフィールドに自動的に追加します。

    • false: パブリック IP アドレスとログ受信時刻を記録する機能を無効にします。

    enableTracking

    bool

    いいえ

    Web トラッキング機能を有効にするかどうかを指定します。デフォルト値は false です。

    encryptConf

    object

    いいえ

    暗号化構成のデータ構造。これには、enable、encrypt_type、および user_cmk_info パラメーターが含まれます。デフォルト値は空です。

    meteringMode

    string

    いいえ

    課金モード。詳細については、「Logstore の管理」をご参照ください。デフォルト値は空です。有効な値:

    • ChargeByFunction: 機能課金

    • ChargeByDataIngest: データ量課金

    説明

    Logstore の queryMode が query に設定されている場合、機能課金のみがサポートされます。

    アカウントでデータ量課金が有効になっていない場合、このパラメーターを ChargeByDataIngest に設定することはできません。

    spec.machineGroups

    この収集構成を適用できるマシングループを指定します。

    • デフォルトの動作: LoongCollector をインストールすると、k8s-group-${clusterId} という名前のマシングループが自動的に作成されます。machineGroups を明示的に設定しない場合、この収集構成はデフォルトでそのマシングループに関連付けられます。

    • 同期メカニズム: loongcollector-operator は、収集構成に関連付けられたマシングループが machineGroups で定義されたリストと同一であることを保証します。このリストにないマシングループは自動的に関連付けが解除されます。

    • 自動作成のサポート: 指定されたマシングループが存在しない場合、システムは同じ名前の 識別子ベースのマシングループ を自動的に作成し、現在の収集構成にアタッチします。

    パラメーター

    データの型

    必須

    説明

    name

    string

    いいえ

    関連付けるマシングループの名前。

    spec.enableUpgradeOverride

    任意。システムが以前の構成を上書きすることを許可するかどうかを指定します。このパラメーターは、異なるバージョンの収集構成間の競合を解決するために使用されます。デフォルト値は false です。

    • true: loongcollector-operator は、AliyunLogConfig によって定義された既存の収集構成を上書きしてアップグレードします。

    • false: 収集構成に競合が存在する場合、AliyunPipelineConfig アプリケーションは失敗します。

    シナリオ: AliyunLogConfig によって定義された収集構成がクラスターに既に存在し、現在の AliyunPipelineConfig と同じ収集構成を参照している場合に競合が発生します。

    同じ収集構成の定義:

    • 同じプロジェクト

      • AliyunLogConfig: クラスターのデフォルトプロジェクトまたは spec.project を使用します。

      • AliyunPipelineConfig: spec.project.name を使用します。

    • 同じ収集構成名

      • AliyunLogConfig: spec.logtailConfig.configName

      • AliyunPipelineConfig: metadata.name

    アップグレードプロセス:

    1. 新しい構成の適用
      ClusterAliyunPipelineConfig が適用され、収集構成が更新されます。

    2. 以前の構成のクリーンアップ
      更新が成功した場合、コントローラーは対応する AliyunLogConfig リソースをクラスターから自動的に削除します。

    3. 移行の完了
      これにより、以前のメソッドから新しいメソッドへの移行が完了します。