配置日志记录代理程序
您可以通过为 Linux 代理程序配置参数或为 Kubernetes 代理程序配置环境变量来定制日志记录代理程序。
支持结束：自 2025 年 3 月 30 日起，不再支持 IBM Log Analysis 和 IBM Cloud Activity Tracker 服务。IBM Cloud Logs 将取代这两项服务。 有关 IBM Cloud Logs 的信息，请参阅 IBM Cloud Logs 文档。
V3 日志记录代理程序的环境变量
| 环境变量 | YAML 路径名 | 描述 | 缺省值 | 样本值 |
|---|---|---|---|---|
LOGDNA_CONFIG_FILE |
缺省配置文件。 | /etc/logdna/config.yaml |
||
LOGDNA_DB_PATH |
log.db_path |
代理程序存储状态信息的目录。 该目录必须位于持久卷上。 代理程序必须对该目录具有写访问权。 |
/var/lib/logdna-agent/ |
|
LOGDNA_INGESTION_KEY |
http.ingestion_key |
对日志记录摄入密钥的引用。 | secretKeyRef | |
LOGDNA_HOST |
http.host |
IBM Log Analysis 采集端点。 | logs.us-south.logging.cloud.ibm.com |
|
LOGDNA_ENDPOINT |
http.endpoint |
采集日志路径。 | /logs/agent/ |
|
LOGDNA_HOSTNAME |
http.params.hostname |
日志源名称。 | 机器的缺省操作系统主机名。 | MyCluster |
LOGDNA_IP |
http.params.ip |
包含为元数据的 IP 地址，用于记录从代理程序转发的行。 | ||
LOGDNA_JOURNALD_PATHS |
journald.paths[] |
要监视的日志记录路径的列表。 | /var/log/journal, /run/systemd/journal |
|
LOGDNA_LOG_DIRS |
log.dirs[] |
定义希望代理监控的自定义路径 使用逗号分隔多个路径 可以使用 glob 模式。 使用双引号来添加球形图。 |
/var/log/ |
/output/,/mylogs/myapplogs/ |
LOGDNA_REDACT_REGEX |
log.line_redact_regex |
可以定义的正则表达式定制规则，用于在代理程序发送日志行之前屏蔽敏感信息。 | ||
LOGDNA_LINE_INCLUSION_REGEX |
log.line_inclusion_regex[] |
可定义的正则表达式定制规则，用于配置要监视的日志行。 设置此字段时，代理程序仅发送与任何模式匹配的日志行。 |
||
LOGDNA_INCLUSION_RULES |
log.include.glob[] |
可定义的定制规则，用于配置要监视的日志文件。 这些文件可以位于通过 logdir 参数定义的任何路径中 可以使用 glob 模式。 有关更多信息，请参阅 Glober rules |
*.json,*.test |
|
LOGDNA_LINE_EXCLUSION_REGEX |
log.line_exclusion_regex[] |
可定义的正则表达式定制规则，用于配置要从监视中排除的日志文件。 有关更多信息，请参阅 regex 语法 这些文件可以位于通过 logdir 参数定义的任何路径中。 |
||
LOGDNA_EXCLUSION_RULES |
log.exclude.glob[] |
可定义的定制规则，用于配置要从受监视中排除的日志文件。 可以使用 glob 模式。 有关更多信息，请参阅 Glober rules |
||
LOGDNA_EXCLUSION_REGEX_RULES |
log.exclude.regex[] |
可定义的正则表达式定制规则，用于配置要从受监视中排除的日志文件。 | /var/log/containers/**,/var/log/pods/** |
|
LOGDNA_USE_SSL |
http.use_ssl |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否应使用 TLS 1.2 。 默认值设置为 true。 |
true |
有效值为 true 和 false。 |
LOGDNA_USE_COMPRESSION |
http.use_compression |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否启用压缩。 默认值设置为 true。 |
true |
true |
LOGDNA_GZIP_LEVEL |
http.gzip_level |
gzip 的压缩级别。 Valid values ( 1, 2, 3, 4, 5, 6, 7, 8, 9).When you set this variable to 1, you are configuring
the agent to use the fastest compression speed but at a lower ratio. 将此变量设置为 9 时，您将配置代理程序以使用最高压缩比率但速度较低。 |
2 |
6 |
LOGDNA_TAGS |
http.params.tags |
定义标记以用于将主机自动分组成动态组。 | prod,appA |
|
LOGDNA_MAC |
http.params.mac |
作为元数据附加到日志行的 MAC 地址。 | ||
LOGDNA_LOOKBACK |
log.lookback |
定义代理程序启动时的回顾策略。 | smallfiles |
有效值为: smallfiles，start 或 none |
LOGDNA_METRICS_PORT |
log.metrics_port |
用于公开代理程序的 Prometheus 度量的端口号。 | ||
LOGDNA_LOG_K8S_EVENTS |
用于定义是否记录 Kubernetes 资源事件的布尔值。 | |||
LOGDNA_USE_K8S_LOG_ENRICHMENT |
设置为通过允许代理程序查询 K8s API 来扩充其他 pod 中的日志行。 | always |
有效值为: always 和 never |
V2 日志记录代理程序的环境变量
| 环境变量 | 描述 | 缺省值 | 样本值 |
|---|---|---|---|
DEFAULT_CONF_FILE |
缺省配置文件。 | /etc/logdna/config.yaml |
|
LOGDNA_PLATFORM |
日志源类型。 | k8s |
|
LOGDNA_INGESTION_KEY |
对日志记录摄入密钥的引用。 | secretKeyRef | |
LOGDNA_HOST |
IBM Log Analysis 采集端点。 | logs.us-south.logging.cloud.ibm.com |
|
LOGDNA_API_HOST |
IBM Log Analysis API 采集端点。 | api.us-south.logging.cloud.ibm.com |
|
LOGDNA_ENDPOINT |
采集日志路径。 | /logs/agent/ |
|
LOGDNA_HOSTNAME |
日志源名称。 | MyCluster |
|
LOGDNA_LOG_DIRS |
定义希望代理监控的自定义路径 使用逗号分隔多个路径 可以使用 glob 模式。 使用双引号来添加球形图。 |
/var/log/ |
/output/,/mylogs/myapplogs/ |
LOGDNA_INCLUSION_RULES |
可定义的定制规则，用于配置要监视的日志文件。 这些文件可以位于通过 logdir 参数定义的任何路径中 可以使用 glob 模式。 有关更多信息，请参阅 Glober rules |
*.json,*.test |
|
LOGDNA_INCLUSION_REGEX_RULES |
可定义的正则表达式定制规则，用于配置要监视的日志文件。 有关更多信息，请参阅 regex 语法 这些文件可以位于通过 logdir 参数定义的任何路径中。 |
||
LOGDNA_EXCLUSION_RULES |
可定义的定制规则，用于配置要从受监视中排除的日志文件。 可以使用 glob 模式。 有关更多信息，请参阅 Glober rules |
||
LOGDNA_EXCLUSION_REGEX_RULES |
可定义的正则表达式定制规则，用于配置要从受监视中排除的日志文件。 | /var/log/containers/**,/var/log/pods/** |
|
LOGDNA_USE_SSL |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否应使用 TLS 1.2 。 默认值设置为 true。 |
true |
true |
LOGDNA_USE_COMPRESSION |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否启用压缩。 默认值设置为 true。 |
true |
true |
LOGDNA_GZIP_LEVEL |
gzip 的压缩级别。 有效值为: 1， 2， 3， 4， 5， 6， 7， 8和 9当您将此变量设置为 1时，您将配置代理程序以使用最快的压缩速度但比率较低。 将此变量设置为 9 时，您将配置代理程序以使用最高压缩比率但速度较低。 |
2 |
6 |
LOGDNA_TAGS |
定义标记以用于将主机自动分组成动态组。 | production,serviceA |
标准 Kubernetes 集群: V1 日志记录代理程序的环境变量
| 环境变量 | 描述 | 缺省值 | 样本值 |
|---|---|---|---|
DEFAULT_CONF_FILE |
缺省配置文件。 | /etc/logdna/config.yaml |
|
LOGDNA_PLATFORM |
日志源类型。 | k8s |
|
LOGDNA_INGESTION_KEY |
对日志记录摄入密钥的引用。 | secretKeyRef | |
LDLOGHOST |
IBM Log Analysis 采集端点。 | logs.us-south.logging.cloud.ibm.com |
|
LDAPIHOST |
IBM Log Analysis API 采集端点。 | api.us-south.logging.cloud.ibm.com |
|
LDLOGPATH |
采集日志路径。 | /logs/agent/ |
|
LOGDNA_HOSTNAME |
日志源名称。 | MyCluster |
|
LOG_DIRS |
定义希望代理监控的自定义路径 使用逗号分隔多个路径 可以使用 glob 模式。 使用双引号来添加球形图。 |
var/log |
/output/,/mylogs/myapplogs/ |
LOGDNA_INCLUDE |
可定义的定制规则，用于配置要监视的日志文件。 这些文件可以位于通过 logdir 参数定义的任何路径中 可以使用 glob 模式。 有关更多信息，请参阅 Glober rules |
*.json,*.test |
|
LOGDNA_INCLUDE_REGEX |
可定义的正则表达式定制规则，用于配置要监视的日志文件。 有关更多信息，请参阅 regex 语法 这些文件可以位于通过 logdir 参数定义的任何路径中。 |
||
LOGDNA_EXCLUDE |
可定义的定制规则，用于配置要从受监视中排除的日志文件。 这些文件可以位于通过 logdir 参数定义的任何路径中 使用逗号分隔多个文件。 可以使用 glob 模式。 也可以配置特定文件。 |
||
LOGDNA_EXCLUDE_REGEX |
可定义的正则表达式定制规则，用于配置要从受监视中排除的日志文件。 | /var/log/containers/*,/var/log/pods/* |
|
LDLOGSSL |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否应使用 TLS 1.2 。 默认值设置为 true。 |
true |
true |
COMPRESS |
布尔值，用于定义在代理程序将日志发送到日志记录实例时是否启用压缩。 默认值设置为 true。 |
true |
true |
GZIP_COMPRESS_LEVEL |
gzip 的压缩级别。 Valid values ( 1, 2, 3, 4, 5, 6, 7, 8, 9).When you set this variable to 1, you are configuring
the agent to use the fastest compression speed but at a lower ratio. 将此变量设置为 9 时，您将配置代理程序以使用最高压缩比率但速度较低。 |
2 |
6 |
LOGDNA_TAGS |
定义标记以用于将主机自动分组成动态组。 | production,serviceA |
Linux: V1 日志记录代理程序的配置参数
| 参数 | 描述 |
|---|---|
tags |
定义标记以用于将主机自动分组成动态组。 |
logdir |
定义希望代理程序监视的定制路径。 使用逗号分隔多个路径。 可以使用 glob 模式。 也可以配置特定文件。 使用双引号输入 glob 模式。 |
exclude |
定义不希望日志代理监控的文件。 **注意：**这些文件可以位于通过日志目录参数定义的任何路径中 使用逗号分隔多个文件。 可以使用 glob 模式。 也可以配置特定文件。 |
exclude_regex |
定义正则表达式模式以过滤掉与模式匹配的任何行。 不要包含前导和尾部 /。 |
hostname |
定义主机名。 此值会覆盖操作系统主机名。 |
autoupdate |
设置为 1 可在更新公共存储库代理程序定义时自动更新代理程序。 设置为 0 可禁用此功能。 |