すべてのプロダクト
Search
ドキュメントセンター

:CreateLogtailPipelineConfig

最終更新日:Jan 08, 2026

Logtail パイプライン構成を作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:CreateLogtailPipelineConfig

create

*All Resource

*

  • log:TLSVersion
なし

リクエスト構文

POST /pipelineconfigs HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

project

string

必須

プロジェクトの名前。

test-project

body

object

任意

Logtail パイプライン構成のコンテンツ。

configName

string

必須

構成の名前。

説明

構成名はプロジェクト内で一意である必要があり、構成の作成後に変更することはできません。名前は、次のルールに従う必要があります:

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

  • 先頭と末尾は、小文字または数字である必要があります。

  • 長さは 2~128 文字である必要があります。

test-config

logSample

string

任意

ログサンプル。複数のログエントリがサポートされています。

2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world

global

object

任意

グローバル構成。

inputs

array<object>

必須

入力プラグインのリスト。

重要 現在、設定できる入力プラグインは 1 つだけです。

object

任意

入力プラグイン。

説明

ファイル入力プラグインのパラメーターについては、「ファイルプラグイン」をご参照ください。他の入力プラグインのパラメーターについては、「処理プラグイン」をご参照ください。

{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] }

processors

array<object>

任意

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

説明

処理プラグインは、ネイティブ処理プラグインと拡張処理プラグインに分類されます。詳細については、「処理プラグイン」をご参照ください。

重要
説明
  • ネイティブプラグインは、テキストログの収集にのみ使用できます。

  • ネイティブプラグインと拡張プラグインを同時に追加することはできません。

  • ネイティブプラグインを使用する場合、次の要件を満たす必要があります:
    • 最初の処理プラグインは、正規表現ベースの解析プラグイン、区切り文字ベースの解析プラグイン、JSON ベースの解析プラグイン、NGINX ベースの解析プラグイン、Apache ベースの解析プラグイン、または IIS ベースの解析プラグインである必要があります。

    • 最初の処理プラグインの後、時間解析処理プラグイン、フィルタープラグイン、および複数のデータマスキングプラグインをそれぞれ 1 つだけ追加できます。

object

任意

処理プラグイン。

説明

ネイティブおよび拡張処理プラグインの詳細については、「処理プラグイン」をご参照ください。

{ "Type": "processor_parse_json_native", "SourceKey": "content" }

aggregators

array<object>

任意

集約プラグインのリスト。

重要 このパラメーターは、拡張処理プラグインを使用する場合にのみ有効です。最大 1 つの集約プラグインを使用できます。

object

任意

集約プラグイン。

flushers

array<object>

必須

出力プラグインのリスト。

重要 現在、追加できる flusher_sls プラグインは 1 つだけです。

object

任意

出力プラグイン。

{ "Type": "flusher_sls", "Logstore": "test" }

task

object

任意

タスク構成。

グローバル構成

パラメータータイプ必須デフォルト値説明
TopicTypestringいいえなしfilepathトピックタイプ。有効値:
  • filepath:ログファイルパスから情報を抽出してトピックとします。この値は、入力プラグインが input_file の場合にのみ有効です。

  • machine_group_topic:構成が適用されるマシングループのトピックを使用します。

  • custom:カスタムトピック。詳細については、「ログトピック」をご参照ください。

TopicFormatstringいいえ。このパラメーターは、TopicType を filepath または custom に設定した場合に必須です。//var/log/(.*).logトピックのフォーマット。
EnableTimestampNanosecondboolいいえfalsefalseタイムスタンプのナノ秒精度を有効にするかどうかを指定します。
PipelineMetaTagKeyobjectいいえなし{"HOST_NAME":"__hostname__"}
重要 このパラメーターは、LoongCollector 3.0.10 以降でのみサポートされています。
LoongCollector 情報に関連するタグを制御します。キーはタグパラメーター名で、値はログ内のタグのフィールド名です。値を __default__ に設定すると、デフォルト値が使用されます。値を空の文字列に設定すると、タグは削除されます。次のタグを設定できます:
  • HOST_NAME:ホスト名。このタグはデフォルトで追加されます。デフォルト値は "__hostname__" です。

  • AGENT_TAG:カスタム識別子。このタグはデフォルトで追加されます。デフォルト値は "__user_defined_id__" です。

  • HOST_ID:ホスト ID。このタグはデフォルトでは追加されません。デフォルト値は "__host_id__" です。

  • CLOUD_PROVIDER:このタグはデフォルトでは追加されません。デフォルト値は "__cloud_provider__" です。

入力プラグイン

ファイル入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/input_fileプラグインのタイプ。値を input_file に設定します。
FilePaths[string]はい/["/var/log/*.log"]収集するログファイルのパス。現在、サポートされているパスは 1 つだけです。パスにはワイルドカード (*) と (**) を使用できます。二重アスタリスク (**) ワイルドカードは 1 回のみ使用でき、ファイル名の前にのみ使用できます。
MaxDirSearchDepthuintいいえ00ファイルパス内の二重アスタリスク (**) ワイルドカードに一致するディレクトリの最大深度。このパラメーターは、ファイルパスに二重アスタリスク (**) ワイルドカードが含まれている場合にのみ有効です。有効値:0~1000。
ExcludeFilePaths[string]いいえなし["/home/admin/*.log"]ファイルパスのブラックリスト。パスは絶対パスである必要があります。ワイルドカード (*) がサポートされています。
ExcludeFiles[string]いいえなし["app*.log", "password"]ファイル名のブラックリスト。ワイルドカード (*) がサポートされています。
ExcludeDirs[string]いいえなし["/home/admin/dir1", "/home/admin/dir2*"]ディレクトリのブラックリスト。パスは絶対パスである必要があります。ワイルドカード (*) がサポートされています。
FileEncodingstringいいえutf8utf8ファイルのエンコード形式。有効値:utf8 および gbk。
TailSizeKBuintいいえ10241024構成を初めて適用するときに、ファイルの末尾から収集するデータのサイズ。ファイルサイズが指定値より小さい場合、データはファイルの先頭から収集されます。単位:KB。有効値:0~10485760。
Multilineobjectいいえなし/複数行ログの集約オプション。
Multiline.Modestringいいえcustomcustom複数行ログの集約モード。有効値:custom および JSON。
Multiline.StartPatternstringMultiline.Mode が custom に設定されている場合は必須なし\d+-\d+-\d+.*複数行ログの最初の行に一致する正規表現。
EnableContainerDiscoveryboolいいえfalsetrueコンテナー検出を有効にするかどうかを指定します。このパラメーターは、Logtail が DaemonSet モードで実行され、収集パスがコンテナー内のパスである場合にのみ有効です。
ContainerFiltersobjectいいえなし/コンテナーフィルタリングオプション。複数のオプションは AND 演算子を使用して結合されます。このパラメーターは、EnableContainerDiscovery を true に設定した場合にのみ有効です。
ContainerFilters.K8sNamespaceRegexstringいいえなしdefaultKubernetes 環境のコンテナーの場合、収集対象のコンテナーが存在する Pod の名前空間を指定します。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.K8sPodRegexstringいいえなしtest-podKubernetes 環境のコンテナーの場合、収集対象のコンテナーが存在する Pod の名前を指定します。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.IncludeK8sLabelmapいいえなし/Kubernetes 環境のコンテナーの場合、収集対象のコンテナーが存在する Pod のラベルを指定します。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは Pod ラベル名で、値は Pod ラベル値です。次のルールが適用されます:
  • マップの値が空の場合、キーを含む Pod が一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致するラベル名と正規表現に一致するラベル値を持つ Pod が一致します。

    • それ以外の場合、キーに一致するラベル名と値に一致するラベル値を持つ Pod が一致します。

ContainerFilters.ExcludeK8sLabelmapいいえなし/Kubernetes 環境のコンテナーの場合、除外対象のコンテナーが存在する Pod のラベルを指定します。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは Pod ラベル名で、値は Pod ラベル値です。次のルールが適用されます:
  • マップの値が空の場合、キーを含む Pod が一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致するラベル名と正規表現に一致するラベル値を持つ Pod が一致します。

    • それ以外の場合、キーに一致するラベル名と値に一致するラベル値を持つ Pod が一致します。

ContainerFilters.K8sContainerRegexstringいいえなしtest-containerKubernetes 環境のコンテナーの場合、収集対象のコンテナーの名前を指定します。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.IncludeEnvmapいいえなし/収集対象のコンテナーの環境変数。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは環境変数名で、値は環境変数値です。次のルールが適用されます:
  • マップの値が空の場合、環境変数にキーが含まれるコンテナーが一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致する環境変数名と正規表現に一致する環境変数値を持つコンテナーが一致します。

    • それ以外の場合、キーに一致する環境変数名と値に一致する環境変数値を持つコンテナーが一致します。

ContainerFilters.ExcludeEnvmapいいえなし/除外対象のコンテナーの環境変数。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは環境変数名で、値は環境変数値です。次のルールが適用されます:
  • マップの値が空の場合、環境変数にキーが含まれるコンテナーが一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致する環境変数名と正規表現に一致する環境変数値を持つコンテナーが一致します。

    • それ以外の場合、キーに一致する環境変数名と値に一致する環境変数値を持つコンテナーが一致します。

ContainerFilters.IncludeContainerLabelmapいいえなし/収集対象のコンテナーのラベル。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、デフォルト値は空になり、すべてのコンテナーが収集されることを示します。正規表現がサポートされています。マップのキーはコンテナーラベル名で、値はコンテナーラベル値です。次のルールが適用されます:
  • マップの値が空の場合、キーを含むコンテナーが一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致するラベル名と正規表現に一致するラベル値を持つコンテナーが一致します。

    • それ以外の場合、キーに一致するラベル名と値に一致するラベル値を持つコンテナーが一致します。

ContainerFilters.ExcludeContainerLabelmapいいえなし/除外対象のコンテナーのラベル。複数の条件は OR 演算子を使用して結合されます。このパラメーターを指定しない場合、デフォルト値は空になり、すべてのコンテナーが収集されることを示します。正規表現がサポートされています。マップのキーはコンテナーラベル名で、値はコンテナーラベル値です。次のルールが適用されます:
  • マップの値が空の場合、キーを含むコンテナーが一致します。

  • マップの値が空でない場合:
    • 値が ^ で始まり $ で終わる場合、キーに一致するラベル名と正規表現に一致するラベル値を持つコンテナーが一致します。

    • それ以外の場合、キーに一致するラベル名と値に一致するラベル値を持つコンテナーが一致します。

ExternalK8sLabelTagmapいいえなし/Kubernetes 環境のコンテナーの場合、ログに追加する Pod ラベル関連のタグを指定します。マップのキーは Pod ラベル名で、値は対応するタグ名です。たとえば、マップに app: k8s_label_app を追加し、Pod に app=serviceA ラベルが含まれている場合、その情報はタグとしてログに追加されます。追加されるフィールドは __tag__:k8s_label_app: serviceA です。Pod に app ラベルが含まれていない場合、空のフィールド __tag__:k8s_label_app: が追加されます。
ExternalEnvTagmapいいえなし/Kubernetes 環境のコンテナーの場合、ログに追加するコンテナー環境変数関連のタグを指定します。マップのキーは環境変数名で、値は対応するタグ名です。たとえば、マップに VERSION: env_version を追加し、コンテナーに VERSION=v1.0.0 環境変数がある場合、その情報はタグとしてログに追加されます。追加されるフィールドは __tag__:env_version: v1.0.0 です。コンテナーに VERSION 環境変数がない場合、空のフィールド __tag__:env_version: が追加されます。
CollectingContainersMetaboolいいえfalsetrueコンテナーメタデータプレビューを有効にするかどうかを指定します。
AppendingLogPositionMetaboolいいえfalsefalseログが属するファイルのメタデータを追加するかどうかを指定します。メタデータには、__tag__:__inode__ フィールドと __file_offset__ フィールドが含まれます。
AllowingIncludedByMultiConfigsboolいいえfalsefalse現在の構成が他の構成に一致するファイルを収集することを許可するかどうかを指定します。
Tagsobjectいいえなし{"FileInodeTagKey":"__inode__"}
重要 このパラメーターは、LoongCollector 3.0.10 以降でのみサポートされています。
ファイル収集に関連するタグを制御します。キーはタグパラメーター名で、値はログ内のタグのフィールド名です。値を __default__ に設定すると、デフォルト値が使用されます。値を空の文字列に設定すると、タグは削除されます。次のタグを設定できます:
  • FileInodeTagKey:ファイルの inode。このタグはデフォルトでは追加されません。デフォルト値は "__inode__" です。

  • FilePathTagKey:ファイルパス。このタグはデフォルトで追加されます。デフォルト値は "__path__" です。

次のパラメーターは、EnableContainerDiscovery パラメーターを true に設定した場合にのみ有効です。
  • K8sNamespaceTagKey:ファイルが配置されているコンテナーの名前空間。このタグはデフォルトで追加されます。デフォルト値は "_namespace_" です。

  • K8sPodNameTagKey:ファイルが配置されている Pod の名前。このタグはデフォルトで追加されます。デフォルト値は "_pod_name_" です。

  • K8sPodUidTagKey:ファイルが配置されている Pod の UID。このタグはデフォルトで追加されます。デフォルト値は "_pod_uid_" です。

  • ContainerNameTagKey:ファイルが配置されているコンテナーの名前。このタグはデフォルトで追加されます。デフォルト値は "_container_name_" です。

  • ContainerIpTagKey:ファイルが配置されているコンテナーの IP アドレス。このタグはデフォルトで追加されます。デフォルト値は "_container_ip_" です。

  • ContainerImageNameTagKey:ファイルが配置されているコンテナーのイメージ。このタグはデフォルトで追加されます。デフォルト値は "_image_name_" です。

FileOffsetKeystringいいえなし__file_offset__
重要 このパラメーターは、LoongCollector 3.0.10 以降でのみサポートされています。
ファイル内のログの位置を示すタグ。このタグはデフォルトでは追加されません。デフォルト値は __file_offset__ です。値を __default__ に設定すると、デフォルト値が使用されます。値を空の文字列に設定すると、タグは削除されます。AppendingLogPositionMeta パラメーターと Tags.FileInodeTagKey または FileOffsetKey パラメーターが同時に指定されている場合、AppendingLogPositionMeta パラメーターは無視されます。

コンテナー標準出力 (レガシー)

パラメータータイプ必須デフォルト値説明
Typestringはい/service_docker_stdoutプラグインのタイプ。値を service_docker_stdout に設定します。
Stdoutブール値いいえtruetrue標準出力を収集するかどうかを指定します。
Stderrブール値いいえtruetrue標準エラー出力を収集するかどうかを指定します。
StartLogMaxOffsetIntegerいいえ128×1024131072初回に収集する既存データの長さ。単位:バイト。このパラメーターは 131072 から 1048576 の間の値に設定することを推奨します。
IncludeLabelマップ、LabelKey と LabelValue は String 型いいえなし

コンテナーラベルのホワイトリスト。このパラメーターは、ログを収集するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、すべてのコンテナーの標準出力が収集されることを示します。コンテナーラベルのホワイトリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、ラベルに LabelKey が含まれるコンテナーが一致します。

  • LabelValue が空でない場合、ラベルに LabelKey=LabelValue が含まれるコンテナーのみが一致します。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue がコンテナーラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、LabelKey を io.kubernetes.container.name に、LabelValue を ^(nginx|cube)$ に設定すると、nginx と cube という名前のコンテナーが一致します。

複数のホワイトリストは OR 演算子を使用して結合されます。コンテナーは、そのラベルがいずれかのホワイトリストの条件を満たす場合に一致します。

ExcludeLabelマップ、LabelKey と LabelValue は String 型いいえなし

コンテナーラベルのブラックリスト。このパラメーターは、除外するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、コンテナーが除外されないことを示します。コンテナーラベルのブラックリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、ラベルに LabelKey が含まれるコンテナーは除外されます。

  • LabelValue が空でない場合、ラベルに LabelKey=LabelValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue がコンテナーラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、LabelKey を io.kubernetes.container.name に、LabelValue を ^(nginx|cube)$ に設定すると、nginx と cube という名前のコンテナーが一致します。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、そのラベルがいずれかのブラックリストの条件を満たす場合に除外されます。

IncludeEnvマップ、EnvKey と EnvValue は String 型いいえなし

環境変数のホワイトリスト。このパラメーターは、ログを収集するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、すべてのコンテナーの標準出力が収集されることを示します。環境変数のホワイトリストを設定する場合は、EnvKey を指定する必要があります。EnvValue はオプションです。

  • EnvValue が空の場合、環境変数に EnvKey が含まれるコンテナーが一致します。

  • EnvValue が空でない場合、環境変数に EnvKey=EnvValue が含まれるコンテナーのみが一致します。

    デフォルトでは、EnvValue は文字列照合に使用されます。EnvValue が環境変数の値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、EnvKey を NGINX_SERVICE_PORT に、EnvValue を `^(80

ExcludeEnvマップ、EnvKey と EnvValue は String 型いいえなし

環境変数のブラックリスト。このパラメーターは、除外するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、コンテナーが除外されないことを示します。環境変数のブラックリストを設定する場合は、EnvKey を指定する必要があります。EnvValue はオプションです。

  • EnvValue が空の場合、環境変数に EnvKey が含まれるコンテナーからのログは除外されます。

  • EnvValue が空でない場合、環境変数に EnvKey=EnvValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、EnvValue は文字列照合に使用されます。EnvValue が環境変数の値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、EnvKey を NGINX_SERVICE_PORT に、EnvValue を ^(80|6379)$ に設定すると、サービスポートが 80 と 6379 のコンテナーが一致します。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、その環境変数がキーと値のペアのいずれかの条件を満たす場合に除外されます。

IncludeK8sLabelマップ、LabelKey と LabelValue は String 型いいえなし

Kubernetes ラベルのホワイトリスト (template.metadata で定義)。このパラメーターは、ログを収集するコンテナーを指定します。Kubernetes ラベルのホワイトリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、Kubernetes ラベルに LabelKey が含まれるコンテナーが一致します。

  • LabelValue が空でない場合、Kubernetes ラベルに LabelKey=LabelValue が含まれるコンテナーのみが一致します。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue が Kubernetes ラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、LabelKey を app に、LabelValue を ^(test1|test2)$ に設定すると、Kubernetes ラベルに app:test1 または app:test2 が含まれるコンテナーが一致します。

複数のホワイトリストは OR 演算子を使用して結合されます。コンテナーは、その Kubernetes ラベルがいずれかのホワイトリストの条件を満たす場合に一致します。

ExcludeK8sLabelマップ、LabelKey と LabelValue は String 型いいえなし

Kubernetes ラベルのブラックリスト (template.metadata で定義)。このパラメーターは、除外するコンテナーを指定します。Kubernetes ラベルのブラックリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、Kubernetes ラベルに LabelKey が含まれるコンテナーは除外されます。

  • LabelValue が空でない場合、Kubernetes ラベルに LabelKey=LabelValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue が Kubernetes ラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。たとえば、LabelKey を app に、LabelValue を ^(test1|test2)$ に設定すると、Kubernetes ラベルに app:test1 または app:test2 が含まれるコンテナーが一致します。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、その Kubernetes ラベルがいずれかのブラックリストの条件を満たす場合に除外されます。

K8sNamespaceRegexStringいいえなし^(default|nginx)$コンテナーからログを収集する基準となる名前空間。正規表現がサポートされています。たとえば、このパラメーターを ^(default|nginx)$ に設定すると、nginx と default の名前空間にあるすべてのコンテナーが一致します。
K8sPodRegexStringいいえなし^(nginx-log-demo.*)$コンテナーからログを収集する基準となる Pod 名。正規表現がサポートされています。たとえば、このパラメーターを ^(nginx-log-demo.*)$ に設定すると、名前が nginx-log-demo で始まる Pod 内のすべてのコンテナーが一致します。
K8sContainerRegexStringいいえなし^(container-test)$ログを収集する基準となるコンテナー名。Kubernetes コンテナー名は spec.containers で定義されます。正規表現がサポートされています。たとえば、このパラメーターを ^(container-test)$ に設定すると、container-test という名前のすべてのコンテナーが一致します。

データ処理パラメーター

パラメータータイプ必須デフォルト値説明
BeginLineRegexStringいいえなし

ログの最初の行に一致する正規表現。

このパラメーターを空のままにすると、単一行モードが使用されます。

行の先頭が正規表現に一致する場合、その行は新しいログの最初の行と見なされます。それ以外の場合、その行は前のログに追加されます。

BeginLineCheckLengthIntegerいいえなし

先頭行マッチングの最大長。単位:バイト。

デフォルト値は 10 × 1024 バイトです。

先頭行マッチングの正規表現が最初の N バイト内で一致する場合、マッチング効率を向上させるためにこのパラメーターを設定することを推奨します。

BeginLineTimeoutMsIntegerいいえなし

先頭行マッチングのタイムアウト期間。単位:ミリ秒。

デフォルト値は 3,000 ミリ秒です。

3,000 ミリ秒以内に新しいログが生成されない場合、マッチングは終了し、最後のログが Simple Log Service にアップロードされます。

MaxLogSizeIntegerいいえなし

ログの最大長デフォルト値は 0 です。単位:バイト。

デフォルト値は 512 × 1024 バイトです。

ログの長さが指定値を超えると、システムは最初の行の検索を停止し、ログを直接アップロードします。

ExternalK8sLabelTagマップ、LabelKey と LabelValue は String 型いいえなし

Kubernetes ラベル (template.metadata で定義) タグ。このパラメーターを設定すると、iLogtail は Kubernetes ラベル関連のフィールドをログに追加します。

たとえば、LabelKey を app に、LabelValue を k8s_label_app に設定し、Pod にラベル app=serviceA が含まれている場合、iLogtail はこの情報をログに追加します。追加されるフィールドは k8s_label_app: serviceA です。Pod に app ラベルが含まれていない場合、空のフィールド k8s_label_app: が追加されます。

ExternalEnvTagマップ、EnvKey と EnvValue は String 型いいえなし

コンテナー環境変数タグ。このパラメーターを設定すると、iLogtail はコンテナー環境変数関連のフィールドをログに追加します。

たとえば、EnvKey を VERSION に、EnvValue を env_version に設定し、コンテナーに環境変数 VERSION=v1.0.0 がある場合、この情報はタグとしてログに追加されます。追加されるフィールドは env_version: v1.0.0 です。コンテナーに VERSION 環境変数がない場合、空のフィールド env_version: が追加されます。

データ処理環境変数

環境変数タイプ必須デフォルト値説明
ALIYUN_LOG_ENV_TAGSStringいいえなし

グローバル環境変数タグ。このパラメーターを設定すると、iLogtail は iLogtail が存在するコンテナーの環境変数に関連するフィールドをログに追加します。複数の環境変数名は縦棒 (|) で区切ります。

たとえば、このパラメーターを node_name|node_ip に設定し、iLogtail コンテナーが関連する環境変数を公開している場合、この情報はタグとしてログに追加されます。追加されるフィールドは node_ip:172.16.0.1 と node_name:worknode です。

コンテナー標準出力 (新バージョン)

パラメータータイプ必須デフォルト値説明
Typestringはい/input_container_stdioプラグインのタイプ。値を input_container_stdio に設定します。
IgnoringStdoutブール値いいえfalsefalse標準出力を無視するかどうかを指定します。false は標準出力を収集することを示します。true は標準出力を収集しないことを示します。
IgnoringStderrブール値いいえfalsefalse標準エラー出力を無視するかどうかを指定します。false は標準エラー出力を収集することを示します。true は標準エラー出力を収集しないことを示します。
TailSizeKBInteger (uint)いいえ10242048構成を初めて適用するときに、ファイルの末尾から収集するデータのサイズ。単位:KB。ファイルサイズが指定値より小さい場合、データはファイルの先頭から収集されます。有効値:0~104857600。
AllowingIncludedByMultiConfigsブール値いいえfalsetrue現在の構成が他の構成に一致するコンテナーから標準出力ログを収集することを許可するかどうかを指定します。デフォルト値の false は、複数の構成による重複収集を防ぎます。
ContainerFiltersObjectいいえなし下記のコンテナーフィルタリングオプション (ContainerFilters) テーブルをご参照くださいコンテナーフィルタリングオプション。複数のオプションは AND 演算子を使用して結合されます。
ExternalK8sLabelTagマップ、LabelKey/LabelValue は Stringいいえなし{"app":"k8s_label_app"}Kubernetes シナリオの場合:Pod ラベルから値を取得し、タグとしてログに追加します。マップのキーは Pod ラベル名で、値はログフィールド名 (タグ名) です。Pod に指定されたラベルがない場合、空のフィールドが追加されます。
ExternalEnvTagマップ、EnvKey/EnvValue は Stringいいえなし{"VERSION":"env_version"}コンテナーシナリオの場合:コンテナー環境変数から値を取得し、タグとしてログに追加します。マップのキーは環境変数名で、値はログフィールド名 (タグ名) です。コンテナーに指定された環境変数がない場合、空のフィールドが追加されます。
MultilineObjectいいえなし下記の複数行集約オプション (Multiline) テーブルをご参照ください複数行集約オプション。

コンテナーフィルタリングオプション (ContainerFilters)

パラメータータイプ必須デフォルト値説明
IncludeK8sLabelマップ、LabelKey/LabelValue は Stringいいえなし{"app":"^(test1|test2)$"}

Kubernetes ラベルのホワイトリスト (Pod の metadata.labels で定義)。このパラメーターは、ログを収集するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、すべてのコンテナーの標準出力が収集されることを示します。

  • LabelValue が空の場合、Kubernetes ラベルに LabelKey が含まれるコンテナーが一致します。

  • LabelValue が空でない場合、Kubernetes ラベルに LabelKey=LabelValue が含まれるコンテナーのみが一致します。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue が Kubernetes ラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のホワイトリストは OR 演算子を使用して結合されます。コンテナーは、その Kubernetes ラベルがいずれかのホワイトリストの条件を満たす場合に一致します。

ExcludeK8sLabelマップ、LabelKey/LabelValue は Stringいいえなし{"env":"^(test.*)$"}

Kubernetes ラベルのブラックリスト (Pod の metadata.labels で定義)。このパラメーターは、除外するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、コンテナーが除外されないことを示します。

  • LabelValue が空の場合、Kubernetes ラベルに LabelKey が含まれるコンテナーは除外されます。

  • LabelValue が空でない場合、Kubernetes ラベルに LabelKey=LabelValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue が Kubernetes ラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、その Kubernetes ラベルがいずれかのブラックリストの条件を満たす場合に除外されます。

IncludeEnvマップ、EnvKey/EnvValue は Stringいいえなし{"NGINX_SERVICE_PORT":"^(80|6379)$"}

環境変数のホワイトリスト。このパラメーターは、ログを収集するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、すべてのコンテナーの標準出力が収集されることを示します。環境変数のホワイトリストを設定する場合は、EnvKey を指定する必要があります。EnvValue はオプションです。

  • EnvValue が空の場合、環境変数に EnvKey が含まれるコンテナーが一致します。

  • EnvValue が空でない場合、環境変数に EnvKey=EnvValue が含まれるコンテナーのみが一致します。

    デフォルトでは、EnvValue は文字列照合に使用されます。EnvValue が環境変数の値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のホワイトリストは OR 演算子を使用して結合されます。コンテナーは、その環境変数がキーと値のペアのいずれかの条件を満たす場合に一致します。

ExcludeEnvマップ、EnvKey/EnvValue は Stringいいえなし{"POD_NAMESPACE":"kube-system"}

環境変数のブラックリスト。このパラメーターは、除外するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、コンテナーが除外されないことを示します。環境変数のブラックリストを設定する場合は、EnvKey を指定する必要があります。EnvValue はオプションです。

  • EnvValue が空の場合、環境変数に EnvKey が含まれるコンテナーは除外されます。

  • EnvValue が空でない場合、環境変数に EnvKey=EnvValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、EnvValue は文字列照合に使用されます。EnvValue が環境変数の値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、その環境変数がキーと値のペアのいずれかの条件を満たす場合に除外されます。

IncludeContainerLabelマップ、LabelKey/LabelValue は Stringいいえなし{"io.kubernetes.container.name":"nginx"}

コンテナーラベルのホワイトリスト。このパラメーターは、ログを収集するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、すべてのコンテナーの標準出力が収集されることを示します。コンテナーラベルのホワイトリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、ラベルに LabelKey が含まれるコンテナーが一致します。

  • LabelValue が空でない場合、ラベルに LabelKey=LabelValue が含まれるコンテナーのみが一致します。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue がコンテナーラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のホワイトリストは OR 演算子を使用して結合されます。コンテナーは、そのラベルがいずれかのホワイトリストの条件を満たす場合に一致します。

ExcludeContainerLabelマップ、LabelKey/LabelValue は Stringいいえなし{"io.kubernetes.pod.namespace":"kube-system"}

コンテナーラベルのブラックリスト。このパラメーターは、除外するコンテナーを指定します。デフォルトでは、このパラメーターは空のままにされ、コンテナーが除外されないことを示します。コンテナーラベルのブラックリストを設定する場合は、LabelKey を指定する必要があります。LabelValue はオプションです。

  • LabelValue が空の場合、ラベルに LabelKey が含まれるコンテナーは除外されます。

  • LabelValue が空でない場合、ラベルに LabelKey=LabelValue が含まれるコンテナーのみが除外されます。

    デフォルトでは、LabelValue は文字列照合に使用されます。LabelValue がコンテナーラベルの値と同一である場合にのみ一致が見つかります。値が ^ で始まり $ で終わる場合、正規表現照合に使用されます。

複数のブラックリストは OR 演算子を使用して結合されます。コンテナーは、そのラベルがいずれかのブラックリストの条件を満たす場合に除外されます。

複数行集約オプション (Multiline)

パラメータータイプ必須デフォルト値説明
ModeStringいいえcustomcustom複数行集約モード。有効値:custom および JSON。このパラメーターを JSON に設定すると、ログは JSON 形式で読み取られ、連結されます。
StartPatternStringいいえ (カスタムモードでは必須)なし\d+-\d+-\d+.*ログの最初の行の正規表現。一致は新しいログの開始を示します。
UnmatchedContentTreatmentStringいいえsingle_linediscard未一致のログセグメントの処理方法。有効値:discard (セグメントを破棄) および single_line (未一致の各セグメントを単一行ログとして出力)。

MySQL 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_mysqlプラグインのタイプ。値を service_mysql に設定します。
Addressstringいいえ127.0.0.1:3306rm-*.mysql.rds.aliyuncs.comMySQL データベースのアドレス。
UserstringいいえrootrootMySQL データベースへのログインに使用するユーザー名。
PasswordstringいいえなしMySQL データベースへのログインに使用するユーザーのパスワード。セキュリティ上の理由から、ユーザー名とパスワードを xxx に設定できます。収集構成がオンプレミスマシンに同期された後、/usr/local/ilogtail/user_log_config.json ファイルで構成を見つけて変更します。詳細については、「ローカル構成の変更」をご参照ください。
重要 コンソールでこのパラメーターを変更すると、同期後にローカル構成が上書きされます。
DataBasestringいいえ/project_databaseデータベースの名前。
DialTimeOutMsintいいえ50005000MySQL データベースへの接続タイムアウト期間。単位:ms。
ReadTimeOutMsintいいえ50005000MySQL クエリ結果の読み取りタイムアウト期間。単位:ms。
StateMentstringいいえ/SELECT 文。CheckPoint を true に設定する場合、SELECT 文の WHERE 句にはチェックポイント列 (CheckPointColumn) を含める必要があります。チェックポイント列と連携するために、疑問符 (?) をプレースホルダーとして使用できます。たとえば、CheckPointColumn を id に、CheckPointStart を 0 に、StateMent を SELECT * from ... where id > ? に設定できます。各収集後、システムは最後のデータ入力の ID をチェックポイントとして保存します。次の収集では、クエリ文の疑問符 (?) がチェックポイントに対応する ID に置き換えられます。
Limitboolいいえfalsetrueページングに LIMIT を使用するかどうかを指定します。
  • true:ページングに LIMIT を使用します。

  • false (デフォルト):ページングに LIMIT を使用しません。

ページングに LIMIT を使用することを推奨します。Limit を true に設定すると、SQL クエリ中にシステムが自動的に SELECT 文に LIMIT 句を追加します。
PageSizeintいいえ/10各ページで返すエントリの数。Limit を true に設定する場合、このパラメーターは必須です。
MaxSyncSizeintいいえ00一度に同期するレコードの最大数。デフォルト値は 0 で、制限がないことを示します。
CheckPointboolいいえfalsetrueチェックポイントを使用するかどうかを指定します。
  • true:チェックポイントを使用します。

  • false (デフォルト):チェックポイントを使用しません。

チェックポイントは、増分データ収集を実装するために、次のデータ収集の開始点として使用できます。
CheckPointColumnstringいいえなし1チェックポイント列の名前。CheckPoint を true に設定する場合、このパラメーターは必須です。警告 この列の値は増分である必要があります。そうでない場合、データが収集されない可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえなしintチェックポイント列のデータの型。有効値:int および time。int 型は int64 として保存されます。time 型は、MySQL の date、datetime、および time 型をサポートします。CheckPoint を true に設定する場合、このパラメーターは必須です。
CheckPointStartstringいいえなしチェックポイント列の初期値。CheckPoint を true に設定する場合、このパラメーターは必須です。
CheckPointSavePerPageboolいいえtruetrue各ページにチェックポイントを保存するかどうかを指定します。
  • true (デフォルト):各ページにチェックポイントを保存します。

  • false:各同期が完了した後にチェックポイントを保存します。

IntervalMsintいいえ6000060000同期間隔。デフォルト値は 60,000 です。単位:ms。

HTTP 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/metric_httpプラグインのタイプ。値を metric_http に設定します。
Addressstringはい/URL のリスト。重要 URL は http または https で始まる必要があります。
IntervalMsintはい/10リクエスト間の間隔。単位:ms。
MethodstringいいえGETGETリクエストメソッド。値はすべて大文字である必要があります。
BodystringいいえなしHTTP ボディのコンテンツ。
Headersmapいいえなし{"key":"value"}HTTP ヘッダーのコンテンツ。例:{"key":"value"}。コンテンツを実際の値に置き換えてください。
PerAddressSleepMsintいいえ100100Addresses リスト内の各 URL のリクエスト間の間隔。単位:ms。
ResponseTimeoutMsintいいえ50005000リクエストのタイムアウト期間。単位:ms。
IncludeBodyboolいいえfalsetrueリクエストボディを収集するかどうかを指定します。デフォルト値は false です。このパラメーターを true に設定すると、リクエストボディのコンテンツは content という名前のキーに保存されます。
FollowRedirectsboolいいえfalsefalseリダイレクトを自動的に処理するかどうかを指定します。
InsecureSkipVerifyboolいいえfalsefalseHTTPS セキュリティチェックをスキップするかどうかを指定します。
ResponseStringMatchstringいいえ/返されたボディコンテンツに対して正規表現チェックを実行します。チェック結果は _response_match_ という名前のキーに保存されます。一致が見つかった場合、値は yes です。一致が見つからなかった場合、値は no です。

Syslog 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_syslogプラグインのタイプ。値を service_syslog に設定します。
Addressstringいいえtcp://127.0.0.1:9999Logtail がリッスンするプロトコル、アドレス、ポート。Logtail は指定されたプロトコル、アドレス、ポートでリッスンし、ログデータを取得します。フォーマットは [tcp/udp]://[ ip ]:[ port ] です。このパラメーターを設定しない場合、デフォルト値の tcp://127.0.0.1:9999 が使用されます。これは、ローカルマシンから転送されたログのみを受信できることを示します。
  • Logtail 構成で指定されたプロトコル、アドレス、ポート番号は、rsyslog 構成ファイルで指定された転送ルールと同じである必要があります。

  • Logtail がインストールされているサーバーにログを受信できる複数の IP アドレスがある場合、アドレスを 0.0.0.0 に設定できます。これは、Logtail がサーバーのすべての IP アドレスでリッスンすることを示します。

ParseProtocolstringいいえなしrfc3164ログの解析に使用されるプロトコル。デフォルト値は空で、ログが解析されないことを示します。有効値:
  • 空:ログを解析しません。

  • rfc3164:RFC3164 プロトコルを使用してログを解析します。

  • rfc5424:RFC5424 プロトコルを使用してログを解析します。
  • auto:ログの内容に基づいて適切な解析プロトコルを自動的に選択します。

IgnoreParseFailureboolいいえtruetrue解析失敗後の操作。このパラメーターを設定しない場合、デフォルト値の true が使用され、解析が破棄され、返された content フィールドが直接入力されることを示します。このパラメーターを false に設定すると、解析が失敗した場合にログは破棄されます。

Systemd Journal 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_journalプラグインのタイプ。値を service_journal に設定します。
JournalPaths[string]はいなし/var/log/journalJournal ログのパス。このパラメーターは、Journal ログが保存されているディレクトリに設定することを推奨します。
SeekPositionstringいいえtailtail初期収集方法。有効値:head および tail。
  • head:すべてのデータを収集します。

  • tail:Logtail 収集構成が適用された後の新しいデータのみを収集します。

Kernelboolいいえtruetrueカーネルログを収集するかどうかを指定します。
Units[string]いいえなし""収集するユニットのリスト。デフォルトでは、このパラメーターは空のままにされ、すべてのユニットが収集されることを示します。
ParseSyslogFacilityboolいいえfalsefalsesyslog ログの facility フィールドを解析するかどうかを指定します。このパラメーターを設定しない場合、フィールドは解析されません。
ParsePriorityboolいいえfalsefalsePriority フィールドを解析するかどうかを指定します。このパラメーターを設定しない場合、フィールドは解析されません。このパラメーターを true に設定すると、Priority フィールドは次のようにマッピングされます:plaintext "0": "emergency" "1": "alert" "2": "critical" "3": "error" "4": "warning" "5": "notice" "6": "informational" "7": "debug"
UseJournalEventTimeboolいいえfalsefalseJournal ログのフィールドをログ時間として使用するかどうかを指定します。このパラメーターを設定しない場合、収集時間がログ時間として使用されます。リアルタイムログ収集の時間差は通常 3 秒以内です。

SQL Server 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_mssqlプラグインのタイプ。値を service_mssql に設定します。
Addressstringいいえ127.0.0.1:1433rm-*.sqlserver.rds.aliyuncs.comSQL Server データベースのアドレス。
UserstringいいえrootrootSQL Server データベースへのログインに使用するユーザー名。
PasswordstringいいえなしSQL Server データベースへのログインに使用するユーザーのパスワード。セキュリティ上の理由から、ユーザー名とパスワードを xxx に設定できます。収集構成がオンプレミスマシンに同期された後、/usr/local/ilogtail/user_log_config.json ファイルで構成を見つけて変更します。詳細については、「ローカル構成の変更」をご参照ください。
重要 コンソールでこのパラメーターを変更すると、同期後にローカル構成が上書きされます。
DataBasestringいいえ/project_databaseデータベースの名前。
DialTimeOutMsintいいえ50005000SQL Server データベースへの接続タイムアウト期間。単位:ms。
ReadTimeOutMsintいいえ50005000SQL Server クエリ結果の読み取りタイムアウト期間。単位:ms。
StateMentstringいいえ/SELECT 文。CheckPoint を true に設定する場合、SELECT 文の WHERE 句にはチェックポイント列 (CheckPointColumn) を含める必要があります。チェックポイント列と連携するために、疑問符 (?) をプレースホルダーとして使用できます。たとえば、CheckPointColumn を id に、CheckPointStart を 0 に、StateMent を SELECT * from ... where id > ? に設定できます。各収集後、システムは最後のデータ入力の ID をチェックポイントとして保存します。次の収集では、クエリ文の疑問符 (?) がチェックポイントに対応する ID に置き換えられます。
Limitboolいいえfalsetrueページングに LIMIT を使用するかどうかを指定します。
  • true:ページングに LIMIT を使用します。

  • false (デフォルト):ページングに LIMIT を使用しません。

ページングに LIMIT を使用することを推奨します。Limit を true に設定すると、SQL クエリ中にシステムが自動的に SELECT 文に LIMIT 句を追加します。
PageSizeintいいえ/10各ページで返すエントリの数。Limit を true に設定する場合、このパラメーターは必須です。
MaxSyncSizeintいいえ00一度に同期するレコードの最大数。デフォルト値は 0 で、制限がないことを示します。
CheckPointboolいいえfalsetrueチェックポイントを使用するかどうかを指定します。
  • true:チェックポイントを使用します。

  • false (デフォルト):チェックポイントを使用しません。

チェックポイントは、増分データ収集を実装するために、次のデータ収集の開始点として使用できます。
CheckPointColumnstringいいえなし1チェックポイント列の名前。CheckPoint を true に設定する場合、このパラメーターは必須です。警告 この列の値は増分である必要があります。そうでない場合、データが収集されない可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえなしintチェックポイント列のデータの型。有効値:int および time。int 型は int64 として保存されます。time 型は、SQL Server の date、datetime、および time 型をサポートします。CheckPoint を true に設定する場合、このパラメーターは必須です。
CheckPointStartstringいいえなしチェックポイント列の初期値。CheckPoint を true に設定する場合、このパラメーターは必須です。
CheckPointSavePerPageboolいいえtruetrue各ページにチェックポイントを保存するかどうかを指定します。
  • true (デフォルト):各ページにチェックポイントを保存します。

  • false:各同期が完了した後にチェックポイントを保存します。

IntervalMsintいいえ6000060000同期間隔。デフォルト値は 60,000 です。単位:ms。

PostgreSQL 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_pgsqlプラグインのタイプ。値を service_pgsql に設定します。
Addressstringいいえ127.0.0.1:5432rm-*.pg.rds.aliyuncs.comPostgreSQL データベースのアドレス。
UserstringいいえrootrootPostgreSQL データベースへのログインに使用するユーザー名。
PasswordstringいいえなしPostgreSQL データベースへのログインに使用するユーザーのパスワード。セキュリティ上の理由から、ユーザー名とパスワードを xxx に設定できます。収集構成がオンプレミスマシンに同期された後、/usr/local/ilogtail/user_log_config.json ファイルで構成を見つけて変更します。詳細については、「ローカル構成の変更」をご参照ください。
重要 コンソールでこのパラメーターを変更すると、同期後にローカル構成が上書きされます。
DataBasestringいいえ/project_databasePostgreSQL データベースの名前。
DialTimeOutMsintいいえ50005000PostgreSQL データベースの接続タイムアウト (ミリ秒)。
ReadTimeOutMsintいいえ50005000PostgreSQL クエリ結果の読み取りタイムアウト。単位:ms。
StateMentstringいいえ/SELECT 文。CheckPoint が true に設定されている場合、StateMent の WHERE 句にはチェックポイント列の条件を含める必要があります。チェックポイント列は CheckPointColumn パラメーターで指定されます。この条件では、チェックポイント値のプレースホルダーとして $1 を使用する必要があります。例:CheckPointColumn を id に、StateMent を SELECT * from ... where id > $1
Limitブール値いいえfalsetrueページングに Limit を使用するかどうかを指定します。
  • true:Limit を使用します。

  • false (デフォルト):Limit を使用しません。

ページングに Limit を使用します。true に設定すると、システムは SQL クエリ中に SELECT 文に自動的に LIMIT 文を追加します。
PageSizeintいいえ/10ページサイズ。`Limit` が `true` に設定されている場合、このパラメーターは必須です。
MaxSyncSizeintいいえ00毎回同期するレコードの最大数。デフォルト値は 0 で、制限がないことを意味します。
CheckPointboolいいえfalsetrueチェックポイントを使用するかどうかを指定します。
  • true:チェックポイントを使用します。

  • false:(デフォルト) チェックポイントを使用しません。

チェックポイントは、増分データ収集を有効にするために、次のデータ収集の開始点として使用できます。
CheckPointColumnstringいいえEmpty1CheckPoint 列の名前。CheckPoint が true に設定されている場合、このパラメーターは必須です。警告 この列の値は増分である必要があります。そうでない場合、各クエリの最大値が次のクエリの入力として使用されるため、データ収集の問題が発生する可能性があります。
CheckPointColumnTypestringいいえemptyintCheckPoint 列のデータの型。サポートされている値は `int` と `time` です。`int` 型は `int64` として保存されます。`time` 型は PostgreSQL の時刻型をサポートします。CheckPoint パラメーターが `true` に設定されている場合、このパラメーターは必須です。
CheckPointStartstringいいえemptyCheckPoint 列の初期値。CheckPoint が true に設定されている場合、このパラメーターは必須です。
CheckPointSavePerPageboolいいえtruetrue各ページにチェックポイントを保存するかどうかを指定します。
  • true (デフォルト):各ページにチェックポイントを保存します。

  • false:各同期が完了した後にチェックポイントを保存します。

IntervalMsintいいえ6000060000同期間隔。デフォルト値は 60000 ms です。

SNMP 入力プラグイン

パラメータータイプ必須デフォルト値説明
Targets[string]はい/127.0.0.1ターゲットマシングループの IP アドレス。
Portstringいいえ161161SNMP プロトコルが使用するポート。
Communitystringいいえpublicpublicコミュニティ文字列。SNMPv1 と SNMPv2 は認証にコミュニティ文字列を使用します。
UserNamestringいいえEmptyrootユーザー名。SNMPv3 はユーザー名による認証をサポートしています。
AuthenticationProtocolstringいいえNoAuthNoAuth認証プロトコル。SNMPv3 は認証プロトコルによる認証をサポートしています。
AuthenticationPassphrasestringいいえEmpty認証パスフレーズ。デフォルト値は空です。AuthenticationProtocolMD5 または SHA に設定した場合、AuthenticationPassphrase を設定する必要があります。
PrivacyProtocolstringいいえNoPrivNoPrivプライバシープロトコル。SNMPv3 はプライバシープロトコルによる認証をサポートしています。
PrivacyPassphrasestringいいえEmptyプライバシープロトコルのパスフレーズ。デフォルトでは、認証パスフレーズと同じです。PrivacyProtocolDES または AES に設定した場合、PrivacyPassphrase を設定する必要があります。
Timeoutintいいえ55クエリ操作のタイムアウト期間 (秒)。
Versionintいいえ22SNMP プロトコルのバージョン。有効な値は 123 です。
TransportstringいいえudpudpSNMP 通信方式。有効な値は udptcp です。
MaxRepetitionsintいいえ00クエリがタイムアウトした後の再試行回数。
Oids[string]いいえEmpty1ターゲットマシンでクエリするオブジェクト識別子 (OID)。
Fields[string]いいえEmptyintターゲットマシンでクエリするフィールド。プラグインはローカルの管理情報ベース (MIB) でこれらのフィールドを検索し、オブジェクト識別子 (OID) に変換してからクエリします。
Tables[string]いいえEmptyターゲットマシンでクエリするテーブル。プラグインは指定されたテーブル内のすべてのフィールドを検索し、ローカルの管理情報ベース (MIB) でそれらを検索し、オブジェクト識別子 (OID) に変換してからクエリします。

スクリプト出力コレクタープラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/input_commandプラグインのタイプ。値は input_command に固定されています。
ScriptTypestringはいEmptyshellスクリプトコンテンツのタイプ。有効な値は bash、shell、python2、python3 です。
Userstringはい/publicコマンドの実行に使用するユーザー名。root 以外のユーザーのみがサポートされています。 * 指定したユーザー名がマシンに存在することを確認してください。最小権限を構成します。監視対象のフォルダーまたはファイルに対して rwx 権限のみを付与します。
ScriptContentstringはいEmptyスクリプトのコンテンツ。コンテンツはプレーンテキストまたは Base64 エンコード形式にできます。長さは 512 × 1024 バイトを超えることはできません。
ContentEncodingstringいいえPlainTextPlainTextスクリプトコンテンツのエンコード形式。このパラメーターはオプションです。有効な値:
  • PlainText (デフォルト):スクリプトコンテンツはプレーンテキストであり、エンコードされていません。

  • Base64:スクリプトコンテンツは Base64 エンコードされています。

LineSplitSepstringいいえEmptyスクリプト出力を分割するために使用される区切り文字。このパラメーターを空のままにすると、出力は分割されず、単一のログエントリとして返されます。
CmdPathstringいいえEmpty/usr/bin/bashスクリプトの実行パス。このパラメーターが空の場合、デフォルトのパスが使用されます。デフォルトのパスは次のとおりです:
  • bash: /usr/bin/bash

  • shell: /usr/bin/sh

  • python2: /usr/bin/python2

  • python3: /usr/bin/python3

TimeoutMilliSecondsintいいえ30003000スクリプト実行のタイムアウト期間。単位:ミリ秒。
IgnoreErrorboolいいえfalsefalseプラグインの実行に失敗した場合にエラーログを無視するかどうかを指定します。デフォルト値は false で、エラーを無視しないことを示します。
Environments[string]いいえ環境変数。デフォルトでは、os.Environ() の値が使用されます。このパラメーターを設定すると、指定された環境変数が os.Environ() の値に追加されます。
IntervalMsintいいえ50005000データが収集されるか、スクリプトが実行される間隔。単位:ミリ秒。

ネイティブプロセッサープラグイン

ネイティブ正規表現解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはいなしprocessor_parse_regex_nativeプラグインのタイプ。値は processor_parse_regex_native に固定されています。
SourceKeystringはいなしcontentソースフィールド名。
Regexstringはいなし(\d+-\d+-\d+)\s+(.*)正規表現。
Keys[string]はいなし["time", "msg"]抽出されたフィールドのリスト。
KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえEmptykeyソースフィールドが保持される場合の新しい名前。このパラメーターを空のままにすると、ソースフィールドは名前変更されません。

ネイティブ JSON 解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_json_nativeプラグインのタイプ。値は processor_parse_json_native に固定されています。
SourceKeystringはい/contentソースフィールドの名前。
KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえemptykeyソースフィールドが保持される場合の新しいフィールド名。このパラメーターを空のままにすると、ソースフィールドは名前変更されません。

ネイティブ区切り文字解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_delimiter_nativeプラグインのタイプ。値は processor_parse_delimiter_native である必要があります。
SourceKeystringはい/contentソースフィールドの名前。
Separatorstringはい/,区切り文字。
Quotestringいいえ""引用符文字。
Keys[string]はい/["time", "msg"]抽出されたフィールドのキーのリスト。
AllowingShortenedFieldsboolいいえtruetrue抽出されたフィールドの数がキーの数より少なくてもよいかどうかを指定します。false に設定すると、フィールドの数がキーの数より少ない場合に解析が失敗します。
OverflowedFieldsTreatmentstringいいえextendextend抽出されたフィールドの数がキーの数より多い場合の動作。有効値:
  • extend:余分なフィールドを保持し、それぞれを別のフィールドとしてログに追加します。余分なフィールドには __column$i__ という名前が付けられます。ここで、$i はフィールドの序数で、0 から始まります。

  • keep:余分なフィールドを保持し、__column0__ という名前の単一のフィールドとしてログに追加します。

  • discard:余分なフィールドを破棄します。

KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえemptykeyソースフィールドが保持されるときにソースフィールドを保存するために使用されるフィールドの名前。名前を指定しない場合、ソースフィールドは名前変更されません。

ネイティブ Apsara 解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_apsara_nativeプラグインのタイプ。値は processor_parse_apsara_native に固定されています。
SourceKeystringはい/contentソースフィールド名。
TimezonestringいいえEmptyGMT+08:00ログのタイムゾーン。東部タイムゾーンの場合は GMT+HH:MM、西部タイムゾーンの場合は GMT-HH:MM の形式です。
KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえEmptykeyソースフィールドが保持される場合にソースフィールドを保存するフィールドの名前。このパラメーターが空の場合、ソースフィールドは名前変更されません。

ネイティブ時間解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_timestamp_nativeプラグインのタイプ。値は processor_parse_timestamp_native である必要があります。
SourceKeystringはい/contentソースフィールドの名前。
SourceFormatstringはい/%Y/%m/%d %H:%M:%Sログの時間フォーマット。詳細については、「時間フォーマット」をご参照ください。
SourceTimezonestringいいえEmptyGMT+08:00ログのタイムゾーン。東部タイムゾーンの場合は GMT+HH:MM、西部タイムゾーンの場合は GMT-HH:MM の形式です。

ネイティブフィルタリングプラグイン

パラメータータイプ必須デフォルト値説明
Typestringはいprocessor_filter_regex_native/プラグインのタイプ。値は processor_filter_regex_native に固定されています。
Includemapはい//ログフィールドのホワイトリスト。キーはフィールド名、値は正規表現です。指定されたフィールドの内容が正規表現に一致する場合にのみログが収集されます。複数の条件を定義した場合、すべての条件を満たすログのみが収集されます。

ネイティブデータマスキングプラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_desensitize_nativeプラグインのタイプ。値は processor_desensitize_native に固定されています。
SourceKeystringはい/contentソースフィールドの名前。
Methodstringはい/constデータマスキングメソッド。有効な値には以下が含まれます:const:機密コンテンツを定数文字列に置き換えます。md5:機密コンテンツをその MD5 値に置き換えます。
ReplacingStringstringいいえ。このパラメーターは、Method が const に設定されている場合に必須です。/******機密コンテンツを置き換えるために使用される定数文字列。
ContentPatternBeforeReplacedStringstringはい/'password:'機密コンテンツのプレフィックスの正規表現。
ReplacedContentPatternstringはい/[^']*機密コンテンツの正規表現。
ReplacingAllboolいいえtruetrue一致したすべての機密コンテンツを置き換えるかどうかを指定します。

拡張プロセッサープラグイン

フィールドのフェッチ

正規表現パターン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_regexプラグインのタイプ。これは processor_regex に固定されています。
SourceKeystringはい/contentソースフィールドの名前。
Regexstringはい/(\d+-\d+-\d+)\s+(.*)正規表現。括弧 () を使用して、フェッチするフィールドを注釈付けします。
Keys[string]はい/["ip", "time", "method"]フェッチされたコンテンツのフィールド名を指定します。例:["ip", "time", "method"]。
NoKeyErrorbooleanいいえfalsefalseソースフィールドが元のログに存在しない場合にシステムがエラーを報告するかどうかを指定します。
  • true:システムはエラーを報告します。

  • false (デフォルト):システムはエラーを報告しません。

NoMatchErrorbooleanいいえfalsefalse正規表現がソースフィールドの値と一致しない場合にシステムがエラーを報告するかどうかを指定します。
  • true:システムはエラーを報告します。

  • false (デフォルト):システムはエラーを報告しません。

KeepSourcebooleanいいえfalsefalse解析されたログにソースフィールドを保持するかどうかを指定します。
  • true:ソースフィールドを保持します。

  • false (デフォルト):ソースフィールドを保持しません。

FullMatchbooleanいいえtruetrue完全一致が見つかった場合にのみフィールド値をフェッチするかどうかを指定します。
  • true (デフォルト):Keys パラメーターで設定したすべてのフィールドが、Regex パラメーターの正規表現に基づいてソースフィールドの値と一致する場合にのみ、フィールド値がフェッチされます。

  • false:部分一致が見つかった場合でもフィールド値がフェッチされます。

KeepSourceIfParseErrorbooleanいいえtruefalse解析に失敗した場合にログにソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):ソースフィールドを保持します。

  • false:ソースフィールドを保持しません。

デリミタモード

パラメータータイプ必須デフォルト値説明
TypestringはいN/Aprocessor_anchorプラグインのタイプ。これは processor_anchor に固定されています。
SourceKeystringはいN/Acontentソースフィールドの名前。
AnchorsarrayはいN/Aアンカーアイテムのリスト。
StartstringはいEmptytime開始キーワード。このパラメーターが空の場合、文字列の先頭に一致します。
StopstringはいEmpty\t終了キーワード。このパラメーターが空の場合、文字列の末尾に一致します。
FieldNamestringはいEmptytime抽出されたコンテンツのフィールド名。
FieldTypestringはいEmptystringフィールドのタイプ。有効な値は string と json です。
ExpandJsonbooleanいいえfalsefalseJSON フィールドを展開するかどうかを指定します。
  • true:フィールドを展開します。

  • false (デフォルト):フィールドを展開しません。

ExpandConnectorstringいいえ__JSON 展開に使用されるコネクタ。デフォルト値はアンダースコア (_) です。
MaxExpandDepthintegerいいえ00JSON 展開の最大深度。デフォルト値は 0 で、制限がないことを意味します。
NoAnchorErrorbooleanいいえfalsefalseアンカーアイテムが見つからない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

NoKeyErrorbooleanいいえfalsefalse指定されたソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

KeepSourcebooleanいいえfalsefalse解析されたログにソースフィールドを保持するかどうかを指定します。
  • true:ソースフィールドを保持します。

  • false (デフォルト):ソースフィールドを保持しません。

CSV パターン

パラメータータイプ必須デフォルト値説明
Typestringはいなしprocessor_csvプラグインのタイプ。これを processor_csv に設定します。
SourceKeyStringはいなしcsvソースフィールドの名前。
SplitKeysString arrayはいなし["date", "ip", "content"]抽出されたコンテンツのフィールド名を指定します。例:["date", "ip", "content"]。重要 分割するフィールドの数が SplitKeys パラメーターで指定されたフィールドの数より少ない場合、SplitKeys の余分なフィールドは無視されます。
PreserveOthersBooleanいいえfalsefalseソースデータに SplitKeys パラメーターで指定されたフィールドよりも多くのフィールドが含まれている場合に、残りのコンテンツを保持するかどうかを指定します。
  • true:残りのコンテンツを保持します。

  • false (デフォルト):残りのコンテンツを保持しません。

ExpandOthersBooleanいいえfalsefalse残りのコンテンツを解析するかどうかを指定します。
  • true:コンテンツを解析します。ExpandKeyPrefix パラメーターを使用して、余分なフィールドの名前のプレフィックスを指定します。

  • false (デフォルト):コンテンツを解析しません。PreserveOthers が true に設定され、ExpandOthers が false に設定されている場合、残りのコンテンツは _decode_preserve_ フィールドに保存されます。

余分なフィールドのコンテンツが標準の CSV 形式でない場合は、保存する前に正規化してください。
ExpandKeyPrefixStringいいえ余分なフィールドの名前のプレフィックス。たとえば、このパラメーターを expand_ に設定すると、フィールド名は expand_1、expand_2 などになります。
TrimLeadingSpaceBooleanいいえfalsefalseフィールド値の先頭のスペースを無視するかどうかを指定します。
  • true:先頭のスペースを無視します。

  • false (デフォルト):先頭のスペースを無視しません。

SplitSepStringいいえ,,区切り文字。デフォルト値はカンマ (,) です。
KeepSourceBooleanいいえfalsefalse解析されたログにソースフィールドを保持するかどうかを指定します。
  • true:ソースフィールドを保持します。

  • false (デフォルト):ソースフィールドを保持しません。

NoKeyErrorBooleanいいえfalsefalse指定されたソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

単一文字区切りパターン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_split_charプラグインのタイプ。値は processor_split_char である必要があります。
SourceKeyStringはいソースフィールドの名前。
SplitSepStringはい区切り文字。これは単一の文字である必要があります。\u0001 などの印刷不可能な文字を使用できます。
SplitKeysString arrayはい["ip", "time", "method"]抽出されたコンテンツのフィールド名を指定します。例:["ip", "time", "method"]。
PreserveOthersBooleanいいえfalsefalse分割されたフィールドの数が SplitKeys のキーの数より多い場合に、残りのフィールドを保持するかどうかを指定します。
  • true:残りのフィールドを保持します。

  • false (デフォルト):残りのフィールドを保持しません。

QuoteFlagBooleanいいえfalsefalse引用符文字を使用するかどうかを指定します。
  • true:引用符文字を使用します。

  • false (デフォルト):引用符文字を使用しません。

QuoteStringいいえ/\u0001引用符文字。これは単一の文字である必要があります。\u0001 などの印刷不可能な文字を使用できます。このパラメーターは、QuoteFlag が true に設定されている場合にのみ有効です。
NoKeyErrorBooleanいいえfalsefalse指定されたソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

NoMatchErrorBooleanいいえfalsefalse指定された区切り文字がログの区切り文字と一致しない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

KeepSourceBooleanいいえfalsefalse解析されたログにソースフィールドを保持するかどうかを指定します。
  • true:ソースフィールドを保持します。

  • false (デフォルト):ソースフィールドを保持しません。

複数文字区切りパターン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_split_stringプラグインのタイプ。このパラメーターは `processor_split_string` に固定されています。
SourceKeyStringはいソースフィールドの名前。
SplitSepStringはい区切り文字。これは単一の文字である必要があります。`\u0001` などの印刷不可能な文字に設定できます。
SplitKeysString arrayはい["key1","key2"]抽出されたコンテンツのフィールド名。例:`["key1","key2"]`。 分割するフィールドの数が `SplitKeys` パラメーターのキーの数より少ない場合、余分なキーは無視されます。
PreserveOthersBooleanいいえfalsefalse分割されたフィールドの数が `SplitKeys` パラメーターのキーの数より多い場合に、残りのフィールドを保持するかどうかを指定します。
  • `true`:残りのフィールドを保持します。

  • `false` (デフォルト):残りのフィールドを保持しません。

ExpandOthersBooleanいいえfalsefalse残りのフィールドを別々のキーと値のペアに展開するかどうかを指定します。このパラメーターは、`PreserveOthers` が `true` に設定されている場合にのみ有効です。
  • `true`:フィールドを展開します。

  • `false` (デフォルト):フィールドを展開しません。

ExpandKeyPrefixStringいいえ/expand_残りのフィールドの名前のプレフィックス。たとえば、このパラメーターを `expand_` に設定すると、フィールド名は `expand_1`、`expand_2` などになります。
NoKeyErrorBooleanいいえfalsefalse`SourceKey` で指定されたソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • `true`:エラーを報告します。

  • `false` (デフォルト):エラーを報告しません。

NoMatchErrorBooleanいいえfalsefalse`SplitSep` で指定された区切り文字でログコンテンツを分割できない場合にエラーを報告するかどうかを指定します。
  • `true`:エラーを報告します。

  • `false` (デフォルト):エラーを報告しません。

KeepSourceBooleanいいえfalsefalse解析されたログにソースフィールドを保持するかどうかを指定します。
  • `true`:ソースフィールドを保持します。

  • `false` (デフォルト):ソースフィールドを保持しません。

キーと値のペアのパターン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_split_key_valueプラグインのタイプ。これを processor_split_key_value に設定します。
SourceKeystringはいソースフィールドの名前。
Delimiterstringいいえ\t\tキーと値のペア間の区切り文字。デフォルト値はタブ文字 \t です。
Separatorstringいいえ::キーと値のペア内のキーと値の間の区切り文字。デフォルト値はコロン (:) です。
KeepSourceBooleanいいえfalsefalse解析後にログにソースフィールドを保持するかどうかを指定します。
  • true:ソースフィールドを保持します。

  • false (デフォルト):ソースフィールドを保持しません。

ErrIfSourceKeyNotFoundBooleanいいえtruefalseソースフィールドが元のログに見つからない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

DiscardWhenSeparatorNotFoundBooleanいいえfalsefalse区切り文字が見つからない場合にキーと値のペアを破棄するかどうかを指定します。
  • true:ペアを破棄します。

  • false (デフォルト):ペアを破棄しません。

ErrIfSeparatorNotFoundBooleanいいえtruefalse指定された区切り文字が見つからない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

ErrIfKeyIsEmptyBooleanいいえtruefalse分割後にキーが空の場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

QuoteStringいいえ引用符文字。値が指定された引用符文字で囲まれている場合、引用符内のコンテンツが値として抽出されます。このパラメーターは複数の文字をサポートします。デフォルトでは、この機能は無効になっています。重要 * 二重引用符 (") を引用符文字として使用するには、バックスラッシュ (\\) でエスケープする必要があります。引用符で囲まれた値内で引用符文字と共にバックスラッシュが使用される場合、バックスラッシュは出力値の一部として含まれます。

Grok パターン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_grokプラグインのタイプ。これは processor_grok に固定されています。
CustomPatternDirString arrayいいえカスタム Grok パターンファイルが配置されているフォルダー。processor_grok プラグインはフォルダー内のすべてのファイルを読み取ります。このパラメーターを追加しない場合、カスタム Grok パターンファイルはインポートされません。重要 カスタム Grok パターンファイルを更新した後、変更を有効にするには Logtail を再起動してください。
CustomPatternsMapいいえカスタム GROK パターン。キーはルール名、値は Grok 式です。デフォルトでサポートされている式の詳細については、「processor_grok」をご参照ください。必要な式がリンクにない場合は、Match にカスタム Grok 式を入力してください。このパラメーターを追加しない場合、カスタム GROK パターンは使用されません。
SourceKeyStringいいえcontentcontentソースフィールドの名前。デフォルト値は content フィールドです。
MatchString arrayはいGrok 式の配列。processor_grok プラグインは、このリストの式に対して上から順にログを照合します。最初に成功した照合の結果を返します。 複数の Grok 式を構成すると、パフォーマンスに影響する可能性があります。最高のパフォーマンスを得るには、5 つ以下の式を使用してください。
TimeoutMilliSecondsLongいいえ0Grok 式を使用してフィールドをフェッチしようとする最大時間 (ミリ秒)。このパラメーターを追加しないか、0 に設定すると、タイムアウトは発生しません。
IgnoreParseFailureBooleanいいえtruetrue解析に失敗したログを無視するかどうかを指定します。
  • true (デフォルト):ログを無視します。

  • false:ログを削除します。

KeepSourceBooleanいいえtruetrue解析成功後にソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):ソースフィールドを保持します。

  • false:ソースフィールドを破棄します。

NoKeyErrorBooleanいいえfalsetrue指定したソースフィールドが元のログに存在しない場合にシステムがエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

NoMatchErrorBooleanいいえtruetrueMatch パラメーターで設定されたどの式もログに一致しない場合にシステムがエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

TimeoutErrorBooleanいいえtruetrue一致がタイムアウトした場合にシステムがエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

フィールドの追加

パラメータータイプ必須デフォルト説明
Typestringはい/processor_add_fieldsプラグインのタイプ。値は processor_add_fields である必要があります。
FieldsMapはい追加するフィールド名と値。フィールドをキーと値のペアとして指定します。複数のフィールドを追加できます。
IgnoreIfExistBooleanいいえfalsefalse同じ名前のフィールドが既に存在する場合に新しいフィールドを無視するかどうかを指定します。
  • true:新しいフィールドを無視します。

  • false (デフォルト):既存のフィールドを新しいフィールドで上書きします。

フィールドの削除

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_dropプラグインのタイプ。値は processor_drop に固定されています。
DropKeysString arrayはい削除するフィールド。複数のフィールドを指定できます。

フィールド名の変更

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_renameプラグインのタイプ。値は processor_rename に固定されています。
NoKeyErrorBooleanいいえfalsefalseログにソースフィールドが見つからない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false:エラーを報告しません。これがデフォルト値です。

SourceKeysString arrayはい名前を変更するソースフィールド。
DestKeysString arrayはいフィールドの新しい名前。

フィールドのパッケージ化

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_packjsonプラグインのタイプ。この値は processor_packjson に固定されています。
SourceKeysString arrayはいパッケージ化する元のフィールド。
DestKeyStringいいえパッケージ化されたデータの宛先フィールド。
KeepSourceBooleanいいえtruetrue解析後にログに元のフィールドを保持するかどうかを指定します。
  • true (デフォルト):元のフィールドを保持します。

  • false:元のフィールドを破棄します。

AlarmIfIncompleteBooleanいいえtruetrue指定された元のフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

JSON フィールドの展開

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_jsonプラグインのタイプ。この値は processor_json に固定されています。
SourceKeyStringはい解析するソースフィールドの名前。
NoKeyErrorBooleanいいえtruetrue指定されたソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

ExpandDepthIntいいえ01JSON オブジェクトの展開深度。デフォルト値は 0 で、制限がないことを示します。値 1 は現在のレベルを示し、以下同様です。
ExpandConnectorStringいいえ__JSON 展開中にフィールド名を結合するために使用されるコネクタ。デフォルト値はアンダースコア (_) です。
PrefixStringいいえ展開されたフィールドの名前に追加するプレフィックス。
KeepSourceBooleanいいえtruetrue解析後にログにソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):ソースフィールドを保持します。

  • false:ソースフィールドを破棄します。

UseSourceKeyAsPrefixBooleanいいえすべての展開されたフィールド名のプレフィックスとしてソースフィールド名を使用するかどうかを指定します。
KeepSourceIfParseErrorBooleanいいえtruetrue解析に失敗した場合に元のログを保持するかどうかを指定します。
  • true (デフォルト):元のログを保持します。

  • false:元のログを破棄します。

ExpandArrayBooleanいいえfalsefalse配列を展開するかどうかを指定します。このパラメーターは Logtail 1.8.0 以降のバージョンでサポートされています。
  • false (デフォルト):配列を展開しません。

  • true:配列を展開します。たとえば、{"k":["1","2"]}{"k[0]":"1","k[1]":"2"} に展開されます。

ログのフィルタリング

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_filter_regexプラグインのタイプ。値は processor_filter_regex に固定されています。
IncludeJSON Objectいいえキーはログフィールド、値は正規表現です。キーと値のペア間には論理 AND が適用されます。指定されたすべてのフィールドが対応する正規表現に一致する場合にのみログが収集されます。
ExcludeJSON Objectいいえキーはログフィールド、値は正規表現です。キーと値のペア間には論理 OR が適用されます。指定されたいずれかのフィールドが対応する正規表現に一致する場合、ログは破棄されます。

ログ時間のフェッチ

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_gotimeプラグインのタイプ。値は processor_gotime に固定されています。
SourceKeyStringはいソースフィールドの名前。
SourceFormatStringはいソース時間のフォーマット。
SourceLocationIntはいソース時間のタイムゾーン。このパラメーターを空のままにすると、Logtail が実行されているホストまたはコンテナーのタイムゾーンが使用されます。
DestKeyStringはい解析されたデータの宛先フィールド。
DestFormatStringはい解析された時間のフォーマット。
DestLocationIntいいえ解析された時間のタイムゾーン。このパラメーターを空のままにすると、ローカルタイムゾーンが使用されます。
SetTimeBooleanいいえtruetrue解析された時間をログ時間として使用するかどうかを指定します。
  • true (デフォルト):解析された時間をログ時間として使用します。

  • false:解析された時間をログ時間として使用しません。

KeepSourceBooleanいいえtruetrue解析後にログにソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):ソースフィールドを保持します。

  • false:ソースフィールドを保持しません。

NoKeyErrorBooleanいいえtruetrue指定されたソースフィールドが元のログに見つからない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

AlarmIfFailBooleanいいえtruetrueログ時間の解析に失敗した場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

IP アドレスの変換

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_geoipプラグインのタイプ。この値は processor_geoip に固定されています。
SourceKeyStringはい変換する IP アドレスを含むソースフィールドの名前。
DBPathStringはい/user/data/GeoLite2-City_20180102/GeoLite2-City.mmdbGeoIP データベースの完全なパス。例:/user/data/GeoLite2-City_20180102/GeoLite2-City.mmdb。
NoKeyErrorBooleanいいえfalsefalseソースフィールドが元のログにない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

NoMatchErrorBooleanいいえtruetrueIP アドレスが無効であるか、データベースに見つからない場合にエラーを報告するかどうかを指定します。
  • true (デフォルト):エラーを報告します。

  • false:エラーを報告しません。

KeepSourceBooleanいいえtruetrue解析後にログにソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):ソースフィールドを保持します。

  • false:ソースフィールドを保持しません。

LanguageStringいいえzh-CNzh-CN言語プロパティ。デフォルト値は zh-CN です。重要 GeoIP データベースに指定された言語が含まれていることを確認してください。

データマスキング

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_desensitizeプラグインのタイプ。値は processor_desensitize に固定されています。
SourceKeystringはいログフィールドの名前。
Methodstringはいconstマスキング解除方法。有効な値:
  • const:機密コンテンツを指定された文字列に置き換えます。ReplaceString パラメーターを使用して文字列を指定します。

  • md5:機密コンテンツをその MD5 ハッシュに置き換えます。

Matchstringいいえfullfull機密コンテンツを識別する方法。有効な値:
  • full (デフォルト):ターゲットフィールドの値全体を置き換えます。

  • regex:正規表現を使用して機密コンテンツを識別します。

ReplaceStringstringいいえ機密コンテンツを置き換える文字列。Methodconst に設定した場合、このパラメーターは必須です。
RegexBeginstringいいえ機密コンテンツのプレフィックスに一致する正規表現。Matchregex に設定した場合、このパラメーターは必須です。
RegexContentstringいいえ機密コンテンツに一致する正規表現。Matchregex に設定した場合、このパラメーターは必須です。

フィールド値のマッピング

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_dict_mapプラグインのタイプ。この値は processor_dict_map に固定されています。
SourceKeyStringはいソースフィールドの名前。
MapDictMapいいえマッピング辞書。このパラメーターを使用して、小さなマッピング辞書を構成します。ローカル CSV 辞書ファイルは必要ありません。重要 DictFilePath パラメーターを設定すると、MapDict パラメーターの設定は有効になりません。
DictFilePathStringいいえCSV 形式の辞書ファイル。このファイルは、区切り文字としてカンマ (,) を使用し、フィールド参照を囲むために二重引用符 (") を使用します。
DestKeyStringいいえ宛先フィールドの名前。
HandleMissingBooleanいいえfalsefalse宛先フィールドがない場合に元のログを処理するかどうかを指定します。
  • true:ログを処理します。システムは Missing パラメーターの値でフィールドを埋めます。

  • false (デフォルト):ログを処理しません。

MissingStringいいえUnknownUnknown元のログに宛先フィールドがない場合に使用する値。デフォルト値は Unknown です。このパラメーターは、HandleMissing が true に設定されている場合にのみ有効です。
MaxDictSizeIntいいえ10001000マッピング辞書の最大サイズ。デフォルト値は 1000 で、最大 1000 個のマッピングルールを保存できることを意味します。プラグインが使用するサーバーメモリを制限するには、この値を小さくします。
ModeStringいいえoverwriteoverwrite宛先フィールドが元のログに既に存在する場合に実行するアクション。
  • overwrite (デフォルト):元のフィールドを上書きします。

  • fill:元のフィールドを上書きしません。

フィールドの暗号化

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_encryptプラグインのタイプ。値は processor_encrypt に固定されています。
SourceKeyString arrayはいソースフィールドの名前。
EncryptionParametersObjectはい暗号鍵の構成。
KeyStringはい暗号鍵。値は 64 文字の 16 進数文字列である必要があります。
IVStringいいえ00000000000000000000000000000000暗号化の初期化ベクトル (IV)。値は 32 文字の 16 進数文字列である必要があります。デフォルト値は 00000000000000000000000000000000 です。
KeyFilePathBooleanいいえ暗号化パラメーターを含むファイルへのパス。このパラメーターが設定されていない場合、システムは Logtail 構成の入力設定のファイルパスからのパスを使用します。
KeepSourceValueIfErrorStringいいえfalsefalse暗号化に失敗した場合に元のフィールド値を保持するかどうかを指定します。
  • `true`:元の値を保持します。

  • `false` (デフォルト):元の値を保持しません。

暗号化に失敗した場合、フィールド値は ENCRYPT_ERROR に置き換えられます。

文字列の置換

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_string_replaceプラグインのタイプ。値は processor_string_replace に固定されています。
Stringはいソースフィールドの名前。
MethodStringはいマッチングメソッドを指定します。有効な値:
  • const:コンテンツを文字列に置き換えます。

  • regex:正規表現を使用してコンテンツを置き換えます。

  • unquote:エスケープ文字を削除します。

MatchStringいいえマッチするコンテンツ。
  • Methodconst に設定されている場合は、置換する文字列を入力します。すべての一致する文字列が置換されます。

  • Methodregex に設定されている場合は、置換するコンテンツに一致する正規表現を入力します。すべての一致する文字列が置換されます。正規表現グループを使用して特定のグループに一致させることもできます。

  • Methodunquote に設定されている場合、このパラメーターは必要ありません。

ReplaceStringStringいいえ置換に使用する文字列。デフォルト値は "" です。
  • Methodconst に設定されている場合は、元のコンテンツを置換する文字列を入力します。

  • Methodregex に設定されている場合は、元のコンテンツを置換する文字列を入力します。正規表現グループに基づく置換がサポートされています。

  • Methodunquote に設定されている場合、このパラメーターは必要ありません。

DestKeyStringいいえ置換されたコンテンツの新しいフィールドを指定します。デフォルトでは、新しいフィールドは追加されません。

データのエンコードとデコード

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_base64_encodingプラグインのタイプ。このパラメーターは processor_base64_encoding に固定されています。
SourceKeyStringはいソースフィールドの名前。
NewKeyStringはいエンコードされた結果を保存するフィールドの名前。
NoKeyErrorBooleanいいえfalsefalseソースフィールドが元のログに存在しない場合にエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

  • false (デフォルト):エラーを報告しません。

ログからメトリックへ

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_log_to_sls_metricプラグインのタイプ。値は processor_log_to_sls_metric に固定されています。
MetricTimeKeyStringいいえログの時間フィールドを指定します。このフィールドは、時系列データの __time_nano__ フィールドにマッピングされます。デフォルトでは、__time__ フィールドの値が使用されます。指定されたフィールドが有効な UNIX タイムスタンプであることを確認してください。サポートされている単位は、秒 (10 桁)、ミリ秒 (13 桁)、マイクロ秒 (16 桁)、ナノ秒 (19 桁) です。
MetricLabelKeys[]Stringはい__labels__ フィールドのキーのリストを指定します。キーは正規表現 ^[a-zA-Z_][a-zA-Z0-9_]*$ に従う必要があります。値には縦棒 (|) または #$# を含めることはできません。詳細については、「時系列データ (メトリック)」をご参照ください。MetricLabelKeys パラメーターに __labels__ フィールドを追加しないでください。元のログに __labels__ フィールドが含まれている場合、その値は新しい __labels__ フィールドに追加されます。
MetricValuesMapはいメトリック名とメトリック値を指定します。メトリック名は __name__ フィールドに対応し、正規表現 ^[a-zA-Z_:][a-zA-Z0-9_:]*$ に従う必要があります。メトリック値は __value__ フィールドに対応し、Double 型である必要があります。詳細については、「時系列データ (メトリック)」をご参照ください。
CustomMetricLabelsMapいいえカスタム __labels__ フィールド。キーは正規表現 ^[a-zA-Z_][a-zA-Z0-9_]*$ に従う必要があります。値には縦棒 (|) または #$# を含めることはできません。詳細については、「時系列データ (メトリック)」をご参照ください。
IgnoreErrorBooleanいいえ一致するログがない場合にエラーログを出力するかどうかを指定します。デフォルト値は false で、エラーログを出力しないことを意味します。

ログからトレースへ

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_otel_traceプラグインのタイプ。このパラメーターは processor_otel_trace に固定されています。
SourceKeyStringはいソースフィールドの名前。
FormatStringはいjson変換後のフォーマット。有効な値:protobuf、json、protojson。
NoKeyErrorBooleanいいえfalsetrueソースフィールドがログに存在しない場合にエラーを報告するかどうかを指定します。デフォルト値は false です。
TraceIDNeedDecodeBooleanいいえTraceID を Base64 からデコードするかどうかを指定します。デフォルト値は false です。Format を protojson に設定し、TraceID が Base64 エンコードされている場合は、TraceIDNeedDecode を true に設定してください。そうしないと、変換が失敗します。
SpanIDNeedDecodeBooleanいいえSpanID を Base64 からデコードするかどうかを指定します。デフォルト値は false です。Format を protojson に設定し、SpanID が Base64 エンコードされている場合は、SpanIDNeedDecode を true に設定してください。そうしないと、変換が失敗します。
ParentSpanIDNeedDecodeBooleanいいえParentSpanID を Base64 からデコードするかどうかを指定します。デフォルト値は false です。Format を protojson に設定し、ParentSpanID が Base64 エンコードされている場合は、ParentSpanIDNeedDecode を true に設定してください。そうしないと、変換が失敗します。

出力プラグイン

SLS 出力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/flusher_slsプラグインのタイプ。この値は flusher_sls に固定されています。
Logstorestringはい/test-logstoreLogstore の名前。

レスポンスフィールド

フィールド

説明

レスポンスフィールドがありません。

成功レスポンス

JSONJSON

{}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。