You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2022/10/19 10:49:57 UTC
[inlong-website] branch master updated: [INLONG-6196][Doc] Add configuration doc for Agent (#570)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 20aefff918 [INLONG-6196][Doc] Add configuration doc for Agent (#570)
20aefff918 is described below
commit 20aefff918d6a3d1fb9b044f3a4a08c8e2ebc219
Author: xueyingzhang <86...@users.noreply.github.com>
AuthorDate: Wed Oct 19 18:49:51 2022 +0800
[INLONG-6196][Doc] Add configuration doc for Agent (#570)
---
docs/modules/agent/configure.md | 71 ++++++++++++++++++++++
.../current/modules/agent/configure.md | 70 +++++++++++++++++++++
2 files changed, 141 insertions(+)
diff --git a/docs/modules/agent/configure.md b/docs/modules/agent/configure.md
new file mode 100644
index 0000000000..d028336ebd
--- /dev/null
+++ b/docs/modules/agent/configure.md
@@ -0,0 +1,71 @@
+---
+title: Configuration
+sidebar_position: 3
+---
+
+## Overview
+
+Uses can set customized configuration in `agent.properties`.
+
+## Common Configuration
+
+| Parameter | Description | Default Value | Notes |
+|----------------------------|--------------------------------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------------------------------------|
+| thread.pool.await.time | max wait time(s) for thread pool to terminate running | 30 | |
+| agent.local.ip | local ip of Agent | 127.0.0.1 | |
+| agent.enable.oom.exit | whether allow Agent to automatically exit when OutOfMemory happens | false | |
+| agent.custom.fixed.ip | custom fixed ip for Agent | `blank` | If `agent.local.ip` and `agent.custom.fixed.ip` are both set, the latter is used first. |
+| agent.fetchCenter.interval | interval time(s) of fetching Agent tasks from InLong-Manager | 30 | |
+| agent.fetcher.classname | customized class for fetching Agent tasks from InLong-Manager | org.apache.inlong.agent.plugin.fetcher.ManagerFetcher | This parameter is used for supporting the development of fetcher plug-in. |
+| channel.memory.capacity | max capacity of memory channel | 5000 | |
+
+## Local Database Cache Configuration
+
+| Parameter | Description | Default Value | Notes |
+|---------------------------|--------------------------------------|---------------|------------------------------------------------------------|
+| agent.localStore.readonly | whether local-store-data is readonly | false | |
+| agent.http.enable | whether enable HTTP service | true | Start a HTTP server and getting job/agent config via http. |
+| agent.http.port | http port of HTTP service | 8008 | |
+
+## Job and JobManager Configuration
+
+| Parameter | Description | Default | Notes |
+|--------------------------|-------------------------------------------|---------|-------|
+| job.monitor.interval | job metric monitor interval(s) | 5 | |
+| job.finish.checkInterval | check interval(s) whether job is finished | 6 | |
+| job.number.limit | the amount of jobs that Agent can support | 15 | |
+
+## Task and TaskManager Configuration
+
+| Parameter | Description | Default | Notes |
+|------------------------|------------------------------------------|---------|-------|
+| task.retry.maxCapacity | max number of retrying tasks | 10000 | |
+| task.monitor.interval | task metric monitor interval(s) | 6 | |
+| task.maxRetry.time | max retry time for single task | 3 | |
+| task.push.maxSecond | max time(s) of pushing data to channel | 2 | |
+| task.pull.maxSecond | max time(s) of pulling data from channel | 2 | |
+
+## InLong-Manager Configuration
+
+| Parameter | Description | Default | Notes |
+|------------------------------|----------------------------------|-----------|--------------------------------------------------------------------------------|
+| agent.manager.vip.http.host | InLong-Manager virtual http host | 127.0.0.1 | |
+| agent.manager.vip.http.port | InLong-Manager virtual http port | 8083 | |
+| agent.manager.auth.secretId | InLong-Manager authentic secretId | `blank` | If InLong-Manager doesn't open authentic service, this parameter can be empty. |
+| agent.manager.auth.secretKey | InLong-Manager authentic secretKey | `blank` | |
+
+## Metric Service Configuration
+
+| Parameter | Description | Default | Notes |
+|--------------------------------------|--------------------------------------------------|---------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
+| metricDomains.Agent.domainListeners | class name of metriclistener | org.apache.inlong.agent.metrics.AgentPrometheusMetricListener | Support multiple methods of reporting metrics, and different class name is separated by spaces. |
+| metricDomains.Agent.snapshotInterval | interval(ms) of reporting metrics | 60000 | |
+| agent.prometheus.exporter.port | exporter server default port if using prometheus | | |
+
+## Audit Service Configuration
+
+| Parameter | Description | Default | Notes |
+|--------------|-------------------------------------|-----------------|-------|
+| audit.enable | whether enable InLong-Audit service | true | |
+| audit.proxys | audit proxy address | 127.0.0.1:10081 | |
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/configure.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/configure.md
new file mode 100644
index 0000000000..1a1bb35c67
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/configure.md
@@ -0,0 +1,70 @@
+---
+title: 参数配置
+sidebar_position: 3
+---
+
+## 概览
+
+Agent 相关参数均在配置文件 `agent.properties` 中设置。
+
+## 通用设置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
+| thread.pool.await.time | 异常发生或关闭 Agent 时，线程等待的最大时间（秒） | 30 | |
+| agent.local.ip | Agent 进程的本机 IP | 127.0.0.1 | |
+| agent.enable.oom.exit | 发生 OutOfMemory 异常时，是否自动退出 Agent 进程 | false | |
+| agent.custom.fixed.ip | 定制化 Agent IP | `blank` | 如果 `agent.local.ip` 和`agent.custom.fixed.ip` 都设置，优先使用后者 |
+| agent.fetchCenter.interval | 从 InLong-Manager 拉取采集任务的单位周期（秒） | 30 | |
+| agent.fetcher.classname | 从 InLong-Manager 拉取采集任务的实现类 | org.apache.inlong.agent.plugin.fetcher.ManagerFetcher | 用于支持 Fetcher 的可插拔化功能 |
+| channel.memory.capacity | 内存 Channel 中的最大消息条数 | 5000 | |
+
+## 本地缓存数据（用于 agent 重启后的任务恢复）设置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|---------------------------|--------------------|-------|---------------------------------------------|
+| agent.localStore.readonly | 本地缓存文件是否只读 | false | |
+| agent.http.enable | 是否开启 HTTP 服务 | true | 如果开启，会启动一个 HTTP 服务器，支持通过 HTTP 方式来获取采集任务 |
+| agent.http.port | HTTP 服务端口号 | 8008 | |
+
+## Job 和 JobManager 相关设置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|--------------------------|----------------------------|------|-----|
+| job.monitor.interval | Job 指标监控的单位周期（秒） | 5 | |
+| job.finish.checkInterval | 检查任务是否完成的单位周期（秒 | 6 | |
+| job.number.limit | Agent 能同时采集的最大任务个数 | 15 | |
+
+## Task 和 TaskManager 相关配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|------------------------|----------------------------------|-------|-----|
+| task.retry.maxCapacity | 最大可重试 Task 个数 | 10000 | |
+| task.monitor.interval | Task 指标监控的单位周期（秒） | 6 | |
+| task.maxRetry.time | 单个 Task 最大可重试次数 | 3 | |
+| task.push.maxSecond | 向 Channel 写数据的最大等待时间（秒） | 2 | |
+| task.pull.maxSecond | 从 Channel 读数据的最大等待时间（秒） | 2 | |
+
+## InLong-Manager 配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|------------------------------|----------------------------|-----------|----------------------------------------|
+| agent.manager.vip.http.host | InLong-Manager 服务的地址 | 127.0.0.1 | |
+| agent.manager.vip.http.port | InLong-Manager 服务的端口号 | 8083 | |
+| agent.manager.auth.secretId | InLong-Manager 的认证ID | `blank` | 如果 InLong-Manager 没有开启认证服务，这个参数无需设置 |
+| agent.manager.auth.secretKey | InLong-Manager 的认证密钥 | `blank` | |
+
+## 指标服务配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|--------------------------------------|---------------------------------|---------------------------------------------------------------|-------------------------|
+| metricDomains.Agent.domainListeners | 指标监听的类，通过该类名反射开启服务 | org.apache.inlong.agent.metrics.AgentPrometheusMetricListener | 支持多种方式，不同实现类用空格分割 |
+| metricDomains.Agent.snapshotInterval | 周期性上报指标的时隙（毫秒） | 60000 | |
+| agent.prometheus.exporter.port | 如果使用 Prometheus 上报，设置端口号 | 9080 | |
+
+## 审计服务配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|--------------|--------------------------|------------------|-----|
+| audit.enable | 是否开启 InLong-Audit 服务 | true | |
+| audit.proxys | InLong-Audit 服务的地址 | 127.0.0.1:10081 | |