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

:UpdateLogtailPipelineConfig

最終更新日:Dec 23, 2025

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:UpdateLogtailPipelineConfig

update

*All Resource

*

  • log:TLSVersion
なし

リクエスト構文

PUT /pipelineconfigs/{configName} HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

configName

string

必須

Logtail パイプライン構成の名前。

test-config

リクエストパラメーター

パラメーター

必須 / 任意

説明

project

string

必須

プロジェクトの名前。

test-project

body

object

任意

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

configName

string

必須

構成の名前。

重要 名前は、リクエストパスの configName パラメーターの値と同じである必要があります。

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 つ、フィルタープラグインを 1 つ、および複数のデータマスキングプラグインのみを追加できます。

object

任意

処理プラグイン。

説明

詳細については、「処理プラグイン」をご参照ください。

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

aggregators

array<object>

任意

アグリゲータープラグインのリスト。

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

object

任意

アグリゲータープラグイン。

flushers

array<object>

必須

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

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

object

任意

出力プラグイン。

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

task

object

任意

グローバル構成

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

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

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

TopicFormatstringはい、TopicType が filepath または custom に設定されている場合。//var/log/(.*).logトピックのフォーマット。
EnableTimestampNanosecondboolいいえfalsefalseタイムスタンプのナノ秒精度を有効にするかどうかを指定します。
PipelineMetaTagKeyobjectいいえEmpty{"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]いいえEmpty["/home/admin/*.log"]ファイルパスのブラックリスト。パスは絶対パスである必要があります。アスタリスク (*) ワイルドカードがサポートされています。
ExcludeFiles[string]いいえEmpty["app*.log", "password"]ファイル名のブラックリスト。アスタリスク (*) ワイルドカードがサポートされています。
ExcludeDirs[string]いいえEmpty["/home/admin/dir1", "/home/admin/dir2*"]ディレクトリのブラックリスト。パスは絶対パスである必要があります。アスタリスク (*) ワイルドカードがサポートされています。
FileEncodingstringいいえutf8utf8ファイルのエンコード形式。有効な値:utf8 および gbk。
TailSizeKBuintいいえ10241024構成が初めて有効になったときの一致したファイルの開始収集位置。ファイルの末尾から測定されます。ファイルサイズがこの値より小さい場合、収集は最初から開始されます。有効な値:0~10485760 KB。
MultilineobjectいいえEmpty/複数行集約オプション。
Multiline.Modestringいいえcustomcustom複数行集約モード。有効な値:custom および JSON。
Multiline.StartPatternstringMultiline.Mode が custom に設定されている場合は必須。Empty\d+-\d+-\d+.*行の開始を示す正規表現。
EnableContainerDiscoveryboolいいえfalsetrueコンテナー検出を有効にするかどうかを指定します。このパラメーターは、Logtail が DaemonSet モードで実行され、収集されたファイルパスがコンテナー内のパスである場合にのみ有効です。
ContainerFiltersobjectいいえEmpty/コンテナーフィルタリングオプション。複数のオプション間の関係は「AND」です。このパラメーターは、EnableContainerDiscovery が true に設定されている場合にのみ有効です。
ContainerFilters.K8sNamespaceRegexstringいいえEmptydefaultKubernetes 環境にデプロイされたコンテナーの場合、収集対象のコンテナーが属する Pod の名前空間の条件を指定します。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.K8sPodRegexstringいいえEmptytest-podKubernetes 環境にデプロイされたコンテナーの場合、収集対象のコンテナーが属する Pod の名前の条件を指定します。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.IncludeK8sLabelmapいいえEmpty/Kubernetes 環境にデプロイされたコンテナーの場合、収集対象のコンテナーが属する Pod のラベル条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは Pod ラベルの名前、値は Pod ラベルの値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つラベルを持つすべての Pod が一致します。

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

    • その他の場合、指定されたキーを持つラベルがあり、そのラベル値が指定された値と同じである Pod が一致します。

ContainerFilters.ExcludeK8sLabelmapいいえEmpty/Kubernetes 環境にデプロイされたコンテナーの場合、収集から除外するコンテナーが属する Pod のラベル条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは Pod ラベルの名前、値は Pod ラベルの値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つラベルを持つすべての Pod が一致します。

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

    • その他の場合、指定されたキーを持つラベルがあり、そのラベル値が指定された値と同じである Pod が一致します。

ContainerFilters.K8sContainerRegexstringいいえEmptytest-containerKubernetes 環境にデプロイされたコンテナーの場合、収集対象のコンテナーの名前の条件を指定します。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。
ContainerFilters.IncludeEnvmapいいえEmpty/収集対象のコンテナーの環境変数条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは環境変数の名前、値は環境変数の値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つ環境変数を持つすべてのコンテナーが一致します。

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

    • その他の場合、指定されたキーを持つ環境変数があり、その変数値が指定された値と同じであるコンテナーが一致します。

ContainerFilters.ExcludeEnvmapいいえEmpty/収集から除外するコンテナーの環境変数条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーは環境変数の名前、値は環境変数の値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つ環境変数を持つすべてのコンテナーが一致します。

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

    • その他の場合、指定されたキーを持つ環境変数があり、その変数値が指定された値と同じであるコンテナーが一致します。

ContainerFilters.IncludeContainerLabelmapいいえEmpty/収集対象のコンテナーのラベル条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、デフォルト値は空になり、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーはコンテナーラベルの名前、値はコンテナーラベルの値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つラベルを持つすべてのコンテナーが一致します。

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

    • その他の場合、指定されたキーを持つラベルがあり、そのラベル値が指定された値と同じであるコンテナーが一致します。

ContainerFilters.ExcludeContainerLabelmapいいえEmpty/収集から除外するコンテナーのラベル条件を指定します。複数の条件間の関係は「OR」です。このパラメーターを追加しない場合、デフォルト値は空になり、すべてのコンテナーが収集されます。正規表現がサポートされています。マップのキーはコンテナーラベルの名前、値はコンテナーラベルの値です。以下のルールが適用されます:
  • マップの値が空の場合、指定されたキーを持つラベルを持つすべてのコンテナーが一致します。

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

    • その他の場合、指定されたキーを持つラベルがあり、そのラベル値が指定された値と同じであるコンテナーが一致します。

ExternalK8sLabelTagmapいいえEmpty/Kubernetes 環境にデプロイされたコンテナーの場合、ログに追加する Pod ラベル関連のタグを指定します。マップのキーは Pod ラベルの名前、値は対応するタグ名です。たとえば、マップに app: k8s_label_app を追加し、Pod に app=serviceA というラベルがある場合、この情報はタグとしてログに追加されます。つまり、フィールド __tag__:k8s_label_app: serviceA が追加されます。Pod に app ラベルがない場合、空のフィールド __tag__:k8s_label_app: が追加されます。
ExternalEnvTagmapいいえEmpty/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いいえEmpty{"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いいえEmpty__file_offset__
重要 このパラメーターは LoongCollector 3.0.10 以降でのみサポートされています。
ログのファイル内での位置を示すタグ。このタグはデフォルトでは追加されません。デフォルト値は __file_offset__ です。値が __default__ の場合、デフォルト値が使用されます。値が空の文字列の場合、タグは削除されます。EnableLogPositionMeta パラメーターが Tags.FileInodeTagKey または FileOffsetKey パラメーターと同時に存在する場合、EnableLogPositionMeta パラメーターは無視されます。

コンテナー stdout (レガシー)

パラメータータイプ必須デフォルト値説明
Typestringはい/service_docker_stdoutプラグインのタイプ。値を service_docker_stdout に設定します。
StdoutBooleanいいえtruetrue標準出力 (stdout) を収集するかどうかを指定します。
StderrBooleanいいえtruetrue標準エラー (stderr) を収集するかどうかを指定します。
StartLogMaxOffsetIntegerいいえ128 × 1024131072最初の収集時に取得する既存データの長さ (バイト単位)。131072 から 1048576 の間の値を推奨します。
IncludeLabelMap、LabelKey と LabelValue は String 型いいえEmpty

収集対象のコンテナーを指定するためのコンテナーラベルのホワイトリスト。デフォルト値は空で、すべてのコンテナーの標準出力が収集されます。コンテナーラベルのホワイトリストを設定する場合、LabelKey は必須で、LabelValue はオプションです。

  • LabelValue が空の場合、指定された LabelKey を持つラベルを持つすべてのコンテナーが一致します。

  • LabelValue が空でない場合、指定された LabelKey=LabelValue を持つラベルを持つコンテナーのみが一致します。

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

複数のホワイトリスト条件間の関係は「OR」であり、コンテナーのラベルがホワイトリスト条件のいずれかを満たす場合に一致します。

ExcludeLabelMap、LabelKey と LabelValue は String 型いいえEmpty

収集からコンテナーを除外するためのコンテナーラベルのブラックリスト。デフォルト値は空で、コンテナーは除外されません。コンテナーラベルのブラックリストを設定する場合、LabelKey は必須で、LabelValue はオプションです。

  • LabelValue が空の場合、指定された LabelKey を持つラベルを持つすべてのコンテナーが除外されます。

  • LabelValue が空でない場合、指定された LabelKey=LabelValue を持つラベルを持つコンテナーのみが除外されます。

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

複数のブラックリスト条件間の関係は「OR」であり、コンテナーのラベルがブラックリスト条件のいずれかを満たす場合に除外されます。

IncludeEnvMap、EnvKey と EnvValue は String 型いいえEmpty

収集対象のコンテナーを指定するための環境変数のホワイトリスト。デフォルト値は空で、すべてのコンテナーの標準出力が収集されます。環境変数のホワイトリストを設定する場合、EnvKey は必須で、EnvValue はオプションです。

  • EnvValue が空の場合、指定された EnvKey を持つ環境変数を持つすべてのコンテナーが一致します。

  • EnvValue が空でない場合、指定された EnvKey=EnvValue を持つ環境変数を持つコンテナーのみが一致します。

    デフォルトでは、EnvValue は文字列として照合されます。つまり、EnvValue が環境変数の値と完全に一致する場合にのみ一致が発生します。値が ^ で始まり $ で終わる場合、それは正規表現による照合です。たとえば、EnvKey を NGINX_SERVICE_PORT に、EnvValue を `^(80

ExcludeEnvMap、EnvKey と EnvValue は String 型いいえEmpty

収集からコンテナーを除外するための環境変数のブラックリスト。デフォルト値は空で、コンテナーは除外されません。環境変数のブラックリストを設定する場合、EnvKey は必須で、EnvValue はオプションです。

  • EnvValue が空の場合、指定された EnvKey を持つ環境変数を持つコンテナーのログは除外されます。

  • EnvValue が空でない場合、指定された EnvKey=EnvValue を持つ環境変数を持つコンテナーのみが除外されます。

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

複数のブラックリスト条件間の関係は「OR」であり、コンテナーの環境変数がキーと値のペアのいずれかを満たす場合に除外されます。

IncludeK8sLabelMap、LabelKey と LabelValue は String 型いいえEmpty

収集対象のコンテナーを指定するための Kubernetes ラベル (template.metadata で定義) のホワイトリスト。Kubernetes ラベルのホワイトリストを設定する場合、LabelKey は必須で、LabelValue はオプションです。

  • LabelValue が空の場合、指定された LabelKey を持つ Kubernetes ラベルを持つすべてのコンテナーが一致します。

  • LabelValue が空でない場合、指定された LabelKey=LabelValue を持つ Kubernetes ラベルを持つコンテナーのみが一致します。

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

複数のホワイトリスト条件間の関係は「OR」であり、コンテナーの Kubernetes ラベルがホワイトリスト条件のいずれかを満たす場合に一致します。

ExcludeK8sLabelMap、LabelKey と LabelValue は String 型いいえEmpty

収集からコンテナーを除外するための Kubernetes ラベル (template.metadata で定義) のブラックリスト。Kubernetes ラベルのブラックリストを設定する場合、LabelKey は必須で、LabelValue はオプションです。

  • LabelValue が空の場合、指定された LabelKey を持つ Kubernetes ラベルを持つすべてのコンテナーが除外されます。

  • LabelValue が空でない場合、指定された LabelKey=LabelValue を持つ Kubernetes ラベルを持つコンテナーのみが除外されます。

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

複数のブラックリスト条件間の関係は「OR」であり、コンテナーの Kubernetes ラベルがブラックリスト条件のいずれかを満たす場合に除外されます。

K8sNamespaceRegexStringいいえEmpty^(default|nginx)$名前空間名で収集対象のコンテナーを指定します。正規表現がサポートされています。たとえば、これを ^(default|nginx)$ に設定すると、nginx および default 名前空間のすべてのコンテナーが一致します。
K8sPodRegexStringいいえEmpty^(nginx-log-demo.*)$Pod 名で収集対象のコンテナーを指定します。正規表現がサポートされています。たとえば、これを ^(nginx-log-demo.*)$ に設定すると、名前が nginx-log-demo で始まる Pod 内のすべてのコンテナーが一致します。
K8sContainerRegexStringいいえEmpty^(container-test)$コンテナー名で収集対象のコンテナーを指定します (Kubernetes コンテナー名は spec.containers で定義されます)。正規表現がサポートされています。たとえば、これを ^(container-test)$ に設定すると、container-test という名前のすべてのコンテナーが一致します。

データ処理パラメーター

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

行の開始を照合するための正規表現。

この設定項目が空の場合、単一行モードを示します。

この式が行の先頭に一致する場合、その行は新しいログとして扱われます。それ以外の場合、その行は前のログに追加されます。

BeginLineCheckLengthIntegerいいえEmpty

行の開始一致をチェックする長さ (バイト単位)。

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

行の開始の正規表現が最初の N バイト内で一致できる場合は、このパラメーターを設定して行の開始一致の効率を向上させることを推奨します。

BeginLineTimeoutMsIntegerいいえEmpty

行の開始を照合するためのタイムアウト期間 (ミリ秒単位)。

デフォルト値は 3000 ミリ秒です。

3000 ミリ秒以内に新しいログが表示されない場合、照合は終了し、最後のログが Simple Log Service にアップロードされます。

MaxLogSizeIntegerいいえEmpty

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

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

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

ExternalK8sLabelTagMap、LabelKey と LabelValue は String 型いいえEmpty

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

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

ExternalEnvTagMap、EnvKey と EnvValue は String 型いいえEmpty

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

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

データ処理環境変数

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

グローバル環境変数のログタグを設定した後、iLogtail は iLogtail コンテナーの環境変数に関連するフィールドをログに追加します。複数の環境変数名は縦線 (|) で区切られます。

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

MySQL 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_mysqlプラグインのタイプ。値を service_mysql に設定します。
Addressstringいいえ127.0.0.1:3306rm-*.mysql.rds.aliyuncs.comMySQL アドレス。
UserstringいいえrootrootMySQL データベースにログインするためのユーザー名。
PasswordstringいいえEmptyユーザーが 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いいえEmpty1チェックポイント列の名前。CheckPoint が true に設定されている場合は、これを設定する必要があります。警告 この列の値は増分でなければなりません。そうでない場合、データが失われる可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえEmptyintチェックポイント列のデータの型。サポートされている型は int と time です。int 型の内部ストレージは int64 です。time 型は MySQL の date、datetime、time 型をサポートします。CheckPoint が true に設定されている場合は、これを設定する必要があります。
CheckPointStartstringいいえEmptyチェックポイント列の初期値。CheckPoint が true に設定されている場合は、これを設定する必要があります。
CheckPointSavePerPageboolいいえtruetrue各ページでチェックポイントを保存するかどうかを指定します。
  • true (デフォルト):各ページでチェックポイントを保存します。

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

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

HTTP 入力プラグイン

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

Syslog 入力プラグイン

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

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

ParseProtocolstringいいえEmptyrfc3164ログの解析に使用するプロトコルを指定します。デフォルトは空で、解析しないことを意味します。オプションは次のとおりです:
  • 空:解析しません。

  • rfc3164:ログの解析に RFC3164 プロトコルを使用することを指定します。

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

IgnoreParseFailureboolいいえtruetrue解析失敗後のアクションを指定します。設定しない場合、デフォルトは true で、解析を中止し、返された content フィールドを直接埋めることを意味します。false に設定すると、解析失敗時にログは破棄されます。

Systemd Journal 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_journalプラグインのタイプ。値を service_journal に設定します。
JournalPaths[string]はいEmpty/var/log/journalJournal ログパス。Journal ログが配置されているディレクトリとして設定することを推奨します。
SeekPositionstringいいえtailtail初期収集方法。head または tail に設定できます。
  • head はすべてのデータを収集することを意味します。

  • tail は Logtail 収集構成が適用された後の新しいデータのみを収集することを意味します。

Kernelboolいいえtruetrueカーネルログを収集するかどうかを指定します。
Units[string]いいえEmpty""収集する Units のリスト。デフォルトは空で、すべて収集されることを意味します。
ParseSyslogFacilityboolいいえfalsefalsesyslog ログの facility フィールドを解析するかどうかを指定します。設定しない場合、解析されません。
ParsePriorityboolいいえfalsefalsePriority フィールドを解析するかどうかを指定します。設定しない場合、解析されません。true に設定すると、Priority フィールドのマッピング関係は次のようになります。 "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いいえEmptyアカウントが 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いいえEmpty1チェックポイント列の名前。CheckPoint が true に設定されている場合は、これを設定する必要があります。警告 この列の値は増分でなければなりません。そうでない場合、データが失われる可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえEmptyintチェックポイント列のデータの型。サポートされている型は int と time です。int 型の内部ストレージは int64 です。time 型は SQL Server の date、datetime、time 型をサポートします。CheckPoint が true に設定されている場合は、これを設定する必要があります。
CheckPointStartstringいいえEmptyチェックポイント列の初期値。CheckPoint が true に設定されている場合は、これを設定する必要があります。
CheckPointSavePerPageboolいいえtruetrue各ページでチェックポイントを保存するかどうかを指定します。
  • true (デフォルト):各ページでチェックポイントを保存します。

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

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

PostgreSQL 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_pgsqlプラグインのタイプ。値を service_pgsql に設定します。
Addressstringいいえ127.0.0.1:5432rm-*.pg.rds.aliyuncs.comPostgreSQL アドレス。
UserstringいいえrootrootPostgreSQL データベースにログインするためのアカウント名。
PasswordstringいいえEmptyアカウントが PostgreSQL データベースにログインするためのパスワード。高いセキュリティ要件がある場合は、ユーザー名とパスワードを xxx に設定します。収集構成がマシンに同期された後、/usr/local/ilogtail/user_log_config.json ファイルで構成を見つけて変更します。詳細については、「ローカル構成の変更」をご参照ください。
重要 コンソールでこのパラメーターを変更すると、同期後にローカル構成が上書きされます。
DataBasestringいいえ/project_databasePostgreSQL データベースの名前。
DialTimeOutMsintいいえ50005000PostgreSQL データベースへの接続タイムアウト期間 (ms)。
ReadTimeOutMsintいいえ50005000PostgreSQL クエリ結果の読み取りタイムアウト期間 (ms)。
StateMentstringいいえ/SELECT 文。CheckPoint が true に設定されている場合、StateMent の SELECT 文の WHERE 条件にはチェックポイント列 (CheckPointColumn パラメーター) を含める必要があり、その値は $1 に設定する必要があります。たとえば、CheckPointColumn を id に、StateMent を SELECT * from ... where id > $1
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いいえEmpty1チェックポイント列の名前。CheckPoint が true に設定されている場合は、これを設定する必要があります。警告 この列の値は増分でなければなりません。そうでない場合、データが失われる可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえEmptyintチェックポイント列のデータの型。サポートされている型は int と time です。int 型の内部ストレージは int64 です。time 型は PostgreSQL の time 型をサポートします。CheckPoint が true に設定されている場合は、これを設定する必要があります。
CheckPointStartstringいいえEmptyチェックポイント列の初期値。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ターゲットマシンでクエリするオブジェクト識別子。
Fields[string]いいえEmptyintターゲットマシンでクエリするフィールド。このプラグインは、まずローカルの Management Information Base (MIB) でフィールドを検索して変換し、オブジェクト識別子に変換してまとめてクエリします。
Tables[string]いいえEmptyターゲットマシンでクエリするテーブル。このプラグインは、まずテーブル内のすべてのフィールドをクエリし、次にローカルの Management Information Base (MIB) でそれらを検索し、オブジェクト識別子に変換してまとめてクエリします。

スクリプト出力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/input_commandプラグインのタイプ。値を input_command に設定します。
ScriptTypestringはいEmptyshellスクリプトコンテンツのタイプを指定します。現在、bash、shell、python2、python3 をサポートしています。
Userstringはい/publicコマンドを実行するために使用されるユーザー名。非 root ユーザーのみがサポートされています。 * 指定されたユーザー名がマシンに存在することを確認してください。 必要なディレクトリまたはファイルにのみ rwx 権限を付与する最小権限を設定することを推奨します。
ScriptContentstringはいEmptyスクリプトコンテンツ。PlainText および 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() の値です。Environments が設定されている場合、設定された環境変数は 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抽出されたフィールドの数が Keys の数より少なくなることを許可するかどうかを指定します。許可しない場合、このシナリオは解析失敗として扱われます。
OverflowedFieldsTreatmentstringいいえextendextend抽出されたフィールドの数が Keys の数より多い場合の動作。有効な値:
  • 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はい//ログフィールドのホワイトリスト。キーはフィールド名、値は正規表現です。これは、現在のイベントが収集されるために、キーで指定されたフィールドのコンテンツが満たすべき条件を示します。複数の条件間の関係は「AND」です。すべての条件が満たされた場合にのみログが収集されます。

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

パラメータータイプ必須デフォルト値説明
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:部分一致も抽出されます。

KeepSourceIfParseErrorbooleantruetruefalse解析に失敗した場合に、解析されたログにソースフィールドを保持するかどうかを指定します。
  • true:保持します。

  • false (デフォルト):保持しません。

アンカーモード

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_anchorプラグインのタイプ。値を processor_anchor に設定します。
SourceKeyアンカー配列はい/contentソースフィールドの名前。
Anchorsstringはい/アンカー項目のリスト。
StartStringはいEmptytime開始キーワード。空の場合、文字列の先頭に一致します。
StopStringはいEmpty\t終了キーワード。空の場合、文字列の末尾に一致します。
FieldNameStringはいEmptytime抽出されたコンテンツのフィールド名を指定します。
FieldTypeStringはいEmptystringフィールドのタイプ。有効な値は string または json です。
ExpondJsonbooleanいいえfalsefalseJSON 展開を実行するかどうかを指定します。
  • true:展開します。

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

ExpondConnecterStringいいえ__JSON 展開のコネクタ。デフォルト値はアンダースコア (_) です。
MaxExpondDepthIntいいえ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:解析します。ExpandOthers パラメーターを介して余分な部分を解析し、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\u0002 などの非表示文字に設定できます。
SplitKeysString arrayはい["key1","key2"]抽出されたコンテンツのフィールド名を指定します。例:["key1","key2"]。 分割するフィールドの数が SplitKeys パラメーターのフィールド数より少ない場合、SplitKeys パラメーターの余分なフィールドは無視されます。
PreserveOthersBooleanいいえfalsefalse分割するフィールドの数が SplitKeys パラメーターのフィールド数より多い場合に、余分な部分を保持するかどうかを指定します。
  • true:保持します。

  • false (デフォルト):保持しません。

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

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

ExpandKeyPrefixStringいいえ/expand_余分な部分の命名プレフィックス。たとえば、expand_ と設定した場合、フィールド名は expand_1、expand_2 となります。
NoKeyErrorBooleanいいえfalsefalse指定したソースフィールドが元のログにない場合にシステムがエラーを報告するかどうかを指定します。
  • true:エラーを報告します。

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

NoMatchErrorBooleanいいえfalsefalse指定した区切り文字がログの区切り文字と一致しない場合にシステムがエラーを報告するかどうかを指定します。
  • 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いいえJSON 展開中にフィールド名に追加するプレフィックス。
KeepSourceBooleanいいえtruetrue解析されたログにソースフィールドを保持するかどうかを指定します。
  • true (デフォルト):保持します。

  • false:破棄します。

UseSourceKeyAsPrefixBooleanいいえ展開されたすべての JSON フィールド名のプレフィックスとしてソースフィールド名を使用するかどうかを指定します。
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 形式の辞書ファイル。この 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暗号化の初期化ベクターを設定します。32 文字の 16 進数である必要があります。デフォルト値は 00000000000000000000000000000000 です。
KeyFilePathBooleanいいえ暗号化パラメーターを読み取るファイルパス。設定しない場合、Logtail 構成 - 入力構成 - ファイルパスから読み取ります。
KeepSourceValueIfErrorStringいいえfalsefalse暗号化に失敗した場合にソースフィールドの値を保持するかどうかを指定します。
  • true:保持します。

  • false (デフォルト):保持しません。

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

文字列の置換

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_string_replaceプラグインのタイプ。値を processor_string_replace に設定します。
SourceKeyStringはいソースフィールドの名前。
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__ フィールドの値が抽出されます。指定されたフィールドが有効で、適切にフォーマットされたタイムスタンプであることを確認してください。現在、秒 (10 桁)、ミリ秒 (13 桁)、マイクロ秒 (16 桁)、ナノ秒 (19 桁) の UNIX タイムスタンプをサポートしています。
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 に設定します。
Logstorestirngはい/test-logstoreLogstore の名前。

レスポンスフィールド

フィールド

説明

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

成功レスポンス

JSONJSON

{}

エラーコード

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

変更履歴

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