Simple Log Service:Logtail 構成 (レガシー)

パラメーター

タイプ

必須

例

説明

enable_root_path_collection

boolean

いいえ

false

D:\log* などの Windows ルートディレクトリからのデータ収集を許可するかどうかを指定します。有効値：

• true: 許可。

• false (デフォルト): 許可しない。

exactly_once_concurrency

int

いいえ

1

ExactlyOnce 書き込み機能を有効にするかどうかを指定します。この機能は、単一ファイルに対して許可される同時送信数を指定します。値は 0～512 の範囲である必要があります。詳細については、「付録: ExactlyOnce 書き込み機能」をご参照ください。有効値：

• 0: ExactlyOnce 書き込み機能を無効にします。

• その他の値: ExactlyOnce 書き込み機能を有効にし、単一ファイルに対して許可される同時送信数を指定します。

enable_log_position_meta

boolean

いいえ

true

元のログファイルからのメタデータをログに追加するかどうかを指定します。これにより、__tag__:__inode__ および __file_offset__ フィールドが追加されます。有効値：

• true: メタデータを追加します。

• false: メタデータを追加しません。

specified_year

uint

いいえ

0

生のログの時刻に年が欠落している場合、このパラメーターを設定して、現在の年または指定された年でログ時刻を補完できます。有効値：

• 0: 現在の年を使用します。

• 特定の年 (例: 2020): 指定された年を使用します。

force_multiconfig

boolean

いいえ

false

この Logtail 構成が、他の Logtail 構成によってすでに照合されているファイルを収集することを許可するかどうかを指定します。デフォルト値は false で、許可されないことを意味します。

これは、ファイルが 2 つの収集構成によって異なる Logstore に収集される場合など、複数書き込みシナリオに適用されます。

raw_log_tag

string

いいえ

__raw__

生のログをアップロードするときに生のログを格納するために使用されるフィールド。デフォルト値は __raw__ です。

blacklist

object

いいえ

なし

収集ブラックリスト構成。詳細については、「blacklist パラメーター」をご参照ください。

tail_size_kb

int

いいえ

1024

新しいファイルの初期収集サイズ。このサイズは収集の開始位置を決定します。デフォルトの初期収集サイズは 1024 KB です。

• 初期収集中に、ファイルが 1024 KB より小さい場合、収集はファイルの先頭から開始されます。

• 初期収集中に、ファイルが 1024 KB より大きい場合、収集はファイルの末尾から 1024 KB 前から開始されます。

ここで初期収集サイズを変更できます。値は 0～10485760 の範囲である必要があります。単位は KB です。

batch_send_interval

int

いいえ

3

集約送信期間。単位は秒です。デフォルト値は 3 です。

max_rotate_queue_size

int

いいえ

20

単一ファイルローテーションキューの長さ。デフォルト値は 20 です。

enable_precise_timestamp

boolean

いいえ

false

高精度時間を抽出するかどうかを指定します。このパラメーターを追加しない場合、デフォルト値は false で、高精度時間は抽出されません。

precise_timestamp_key

string

いいえ

"precise_timestamp"

高精度タイムスタンプを格納するフィールド。このパラメーターを追加しない場合、デフォルトのフィールドは precise_timestamp です。

precise_timestamp_unit

string

いいえ

"ms"

高精度タイムスタンプの単位。このパラメーターを追加しない場合、デフォルトは ms です。有効な値には、ms (ミリ秒)、us (マイクロ秒)、ns (ナノ秒) が含まれます。

パラメーター

タイプ

必須

例

説明

logType

string

はい

common_reg_log

ログ収集モード。次のモードがサポートされています。

• json_log: JSON モード。

• common_reg_log: 完全な正規表現モード。

• plugin: プラグインモード。

• delimiter_log: 区切り文字モード。

logPath

string

はい

/var/log/http/

ログファイルのパス。

filePattern

string

はい

access*.log

ログファイルの名前。

topicFormat

string

はい

none

トピック生成方法。有効値：

• none: ログトピックを生成しません。

• default: ログファイルパスをログトピックとして使用します。

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

• ファイルパス正規表現: ログファイルパスの一部をログトピックとして使用します。例: /var/log/(.*).log。

詳細については、「ログトピック」をご参照ください。

timeFormat

string

いいえ

%Y/%m/%d %H:%M:%S

ログ時間形式。詳細については、「時間形式」をご参照ください。

preserve

boolean

いいえ

true

ログファイルが指定された時間内に更新されない場合、タイムアウトしたと見なされます。有効値：

• true (デフォルト): タイムアウトしません。

• false: ログファイルが 30 分以内に更新されない場合、タイムアウトしたと見なされ、監視されなくなります。

preserveDepth

integer

いいえ

1

preserve を false に設定した場合、タイムアウトの最大ディレクトリ深度を指定する必要があります。値は 1～3 の範囲である必要があります。

fileEncoding

string

いいえ

utf8

ログファイルのエンコード形式。有効な値は utf8 と gbk です。

discardUnmatch

boolean

いいえ

true

照合に失敗したログを破棄するかどうかを指定します。有効値：

• true: 照合に失敗したログを破棄します。

• false: 照合に失敗したログを破棄しません。

maxDepth

int

いいえ

100

監視対象のログディレクトリの最大深度。値は 0～1,000 の範囲である必要があります。値 0 は、現在のディレクトリのみが監視されることを意味します。

delaySkipBytes

int

いいえ

0

遅延データを破棄するためのしきい値。有効値：

• 0 (デフォルト): データを破棄しません。

• その他の値: 収集遅延がこの値 (例: 1024 KB) を超えた場合、遅延データは破棄されます。

dockerFile

boolean

いいえ

false

収集対象のオブジェクトファイルがコンテナー内のファイルであるかどうかを指定します。デフォルト値は false です。

dockerIncludeLabel

JSON オブジェクト

いいえ

なし

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

• LabelValue が空の場合、LabelKey を含むラベルを持つすべてのコンテナーが照合されます。

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

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

dockerExcludeLabel

JSON オブジェクト

いいえ

なし

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

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

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

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

dockerIncludeEnv

JSON オブジェクト

いいえ

なし

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

• EnvValue が空の場合、EnvKey を含む環境変数を持つすべてのコンテナーが照合されます。

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

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

dockerExcludeEnv

JSON オブジェクト

いいえ

なし

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

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

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

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

パラメーター

タイプ

必須

例

説明

timeKey

string

いいえ

time

時間フィールドのキー名。