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

:CreateLogtailPipelineConfig

最終更新日: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: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 つ、フィルタープラグインを 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構成が最初に有効になったときにファイルの末尾から収集されるデータのサイズです。ファイルサイズがこの値より小さい場合、データはファイルの先頭から収集されます。有効な値:0~10485760 KB。
Multilineobjectいいえ/複数行集約オプションです。
Multiline.Modestringいいえcustomcustom複数行集約モードです。有効な値:custom と JSON。
Multiline.StartPatternstringこのパラメーターは、Multiline.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標準出力 (stdout) を収集するかどうかを指定します。
Stderrブール値いいえtruetrue標準エラー出力 (stderr) を収集するかどうかを指定します。
StartLogMaxOffsetIntegerいいえ128 × 1024131072最初の収集時に取得する既存データの長さ (バイト単位) です。この値を 131072 から 1048576 の間の数値に設定することを推奨します。
IncludeLabelマップ、ここで LabelKey と LabelValue は文字列型ですいいえ

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

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

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

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

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

ExcludeLabelマップ、ここで LabelKey と LabelValue は文字列型ですいいえ

コンテナーラベルのブラックリストで、収集からコンテナーを除外するために使用されます。デフォルトでは、このパラメーターは空で、コンテナーは除外されないことを示します。コンテナーラベルのブラックリストを設定する場合、LabelKey は必須で、LabelValue はオプションです。

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

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

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

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

IncludeEnvマップ、ここで EnvKey と EnvValue は文字列型ですいいえ

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

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

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

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

ExcludeEnvマップ、ここで EnvKey と EnvValue は文字列型ですいいえ

環境変数のブラックリストで、収集からコンテナーを除外するために使用されます。デフォルトでは、このパラメーターは空で、コンテナーは除外されないことを示します。環境変数のブラックリストを設定する場合、EnvKey は必須で、EnvValue はオプションです。

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

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

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

複数のブラックリストは論理 OR で結合されます。コンテナーは、その環境変数が任意のキーと値のペアの条件を満たす場合に除外されます。

IncludeK8sLabelマップ、ここで LabelKey と LabelValue は文字列型ですいいえ

template.metadata で定義されている Kubernetes ラベルのホワイトリストを使用して、収集対象のコンテナーを指定します。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 ラベルがいずれかのホワイトリストの条件を満たす場合に一致します。

ExcludeK8sLabelマップ、ここで LabelKey と LabelValue は文字列型ですいいえ

template.metadata で定義されている Kubernetes ラベルのブラックリストを使用して、収集からコンテナーを除外します。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いいえ^(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いいえ

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

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

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

MaxLogSizeIntegerいいえ

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

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

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

ExternalK8sLabelTagマップ、ここで LabelKey と LabelValue は文字列型ですいいえ

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 は文字列型ですいいえ

コンテナー環境変数ログタグを設定すると、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 を追加することでタグとしてログに追加されます。

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同期間隔です。デフォルト値は 60000 (ms) です。

HTTP 入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/metric_httpプラグインのタイプです。値を metric_http に設定します。
Addressstringはい/URL のリストです。 重要 URL は http または https で始まる必要があります。
IntervalMsintはい/10リクエスト間の間隔 (ms) です。
MethodstringいいえGETGETリクエストメソッド名です。大文字である必要があります。
BodystringいいえHTTP Body フィールドのコンテンツです。
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 は Logtail 構成に基づいてリッスンし、ログデータを取得します。フォーマットは [tcp/udp]://[ ip ]:[ port ] です。このパラメーターが構成されていない場合、デフォルト値 tcp://127.0.0.1:9999 が使用され、ローカルで転送されたログのみを受信できることを意味します。
  • Logtail 構成で指定されたリスニングプロトコル、アドレス、ポート番号は、rsyslog 構成ファイルで指定された転送ルールと同じでなければなりません。

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

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

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

  • auto:Logtail はログコンテンツに基づいて適切な解析プロトコルを自動的に選択します。

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

Systemd ジャーナル入力プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/service_journalプラグインのタイプです。値を service_journal に設定します。
JournalPaths[string]はい/var/log/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いいえfalsefalseジャーナルログのフィールドをログ時刻として使用するかどうかを指定します。このパラメーターが構成されていない場合、収集時刻がログ時刻として使用されます。リアルタイムログ収集の時間差は通常 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同期間隔です。デフォルト値は 60000 (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 データベースへの接続タイムアウト期間 (ms) です。
ReadTimeOutMsintいいえ50005000PostgreSQL クエリ結果の読み取りタイムアウト期間 (ms) です。
StateMentstringいいえ/SELECT 文です。CheckPoint を true に設定した場合、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いいえ1チェックポイント列の名前です。CheckPoint を true に設定した場合は、このパラメーターが必須です。警告 この列の値は増分でなければなりません。そうでない場合、収集中にデータが欠落する可能性があります。各クエリ結果の最大値が、次のクエリの入力として使用されます。
CheckPointColumnTypestringいいえintチェックポイント列のデータの型です。サポートされている値:int と time。int 型は内部的に int64 として格納されます。time 型は、PostgreSQL の time 型をサポートします。CheckPoint を true に設定した場合は、このパラメーターが必須です。
CheckPointStartstringいいえチェックポイント列の初期値です。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いいえrootユーザー名です。SNMPv3 はユーザー名を使用した認証をサポートしています。
AuthenticationProtocolstringいいえNoAuthNoAuth認証プロトコルです。SNMPv3 は認証プロトコルを使用した認証をサポートしています。
AuthenticationPassphrasestringいいえ認証パスワードです。デフォルト値は空です。AuthenticationProtocolMD5 または SHA に設定した場合、AuthenticationPassphrase を設定する必要があります。
PrivacyProtocolstringいいえNoPrivNoPrivプライバシープロトコルです。SNMPv3 はプライバシープロトコルを使用した認証をサポートしています。
PrivacyPassphrasestringいいえプライバシープロトコルのパスワードです。デフォルトでは、認証パスワードと同じです。PrivacyProtocolDES または AES に設定した場合、PrivacyPassphrase を設定する必要があります。
Timeoutintいいえ55単一のクエリ操作のタイムアウト期間 (秒単位) です。
Versionintいいえ22SNMP プロトコルのバージョンです。有効な値:123
TransportstringいいえudpudpSNMP 通信方式です。有効な値:udptcp
MaxRepetitionsintいいえ00クエリタイムアウト後の再試行回数です。
Oids[string]いいえ1ターゲットマシンでクエリするオブジェクト識別子です。
Fields[string]いいえintターゲットマシンでクエリするフィールドです。このプラグインは、まずローカルの管理情報ベース (MIB) を参照してフィールドを変換し、オブジェクト識別子に変換してから、まとめてクエリします。
Tables[string]いいえターゲットマシンでクエリするテーブルです。このプラグインは、まずテーブル内のすべてのフィールドをクエリし、次にローカルの MIB を参照してオブジェクト識別子に変換し、まとめてクエリします。

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

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

  • Base64:Base64 エンコーディングです。

LineSplitSepstringいいえスクリプト出力コンテンツのデリミタです。これが空の場合、分割は行われず、出力全体が単一のデータ入力として返されます。
CmdPathstringいいえ/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いいえkeyソースフィールドを保持する場合に格納するフィールド名です。指定しない場合、デフォルトではソースフィールドは名前変更されません。

JSON 解析プラグイン

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

デリミタ解析プラグイン

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

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

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

KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえkeyソースフィールドを保持する場合に格納するフィールド名です。指定しない場合、デフォルトではソースフィールドは名前変更されません。

Apsara 解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_apsara_nativeプラグインのタイプです。値を processor_parse_apsara_native に設定します。
SourceKeystringはい/contentソースフィールド名です。
TimezonestringいいえGMT+08:00ログ時刻のタイムゾーンです。フォーマットは GMT+HH:MM (UTC の東) または GMT-HH:MM (UTC の西) です。
KeepingSourceWhenParseFailboolいいえfalsefalse解析に失敗した場合にソースフィールドを保持するかどうかを指定します。
KeepingSourceWhenParseSucceedboolいいえfalsefalse解析に成功した場合にソースフィールドを保持するかどうかを指定します。
RenamedSourceKeystringいいえkeyソースフィールドを保持する場合に格納するフィールド名です。指定しない場合、デフォルトではソースフィールドは名前変更されません。

時刻解析プラグイン

パラメータータイプ必須デフォルト値説明
Typestringはい/processor_parse_timestamp_nativeプラグインのタイプです。値を processor_parse_timestamp_native に設定します。
SourceKeystringはい/contentソースフィールド名です。
SourceFormatstringはい/%Y/%m/%d %H:%M:%Sログ時刻のフォーマットです。詳細については、「時刻フォーマット」をご参照ください。
SourceTimezonestringいいえGMT+08:00ログ時刻のタイムゾーンです。フォーマットは GMT+HH:MM (UTC の東) または GMT-HH:MM (UTC の西) です。

フィルタープラグイン

パラメーター必須デフォルト値説明
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はいtime開始キーワードです。空の場合、文字列の先頭に一致します。
StopStringはい\t終了キーワードです。空の場合、文字列の末尾に一致します。
FieldNameStringはいtime抽出されたコンテンツのフィールド名を指定します。
FieldTypeStringはいstringフィールドのタイプです。有効な値: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

{}

エラーコード

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

変更履歴

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