You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by go...@apache.org on 2021/07/07 07:18:43 UTC
[incubator-inlong-website] branch master updated: [INLONG-669]
adjust quickstart in agent and proxy (#83)
This is an automated email from the ASF dual-hosted git repository.
gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 42d721d [INLONG-669] adjust quickstart in agent and proxy (#83)
42d721d is described below
commit 42d721ddaf2cc975148878e0ab44cab649a0afec
Author: ziruipeng <zp...@connect.ust.hk>
AuthorDate: Wed Jul 7 15:18:37 2021 +0800
[INLONG-669] adjust quickstart in agent and proxy (#83)
Co-authored-by: stingpeng <st...@tencent.com>
---
docs/en-us/modules/agent/img/architecture.png | Bin 0 -> 43613 bytes
docs/en-us/modules/agent/quick_start.md | 18 ++++--
docs/en-us/modules/dataproxy/quick_start.md | 10 +---
docs/zh-cn/modules/agent/quick_start.md | 76 +++++++++++++-------------
docs/zh-cn/modules/dataproxy/quick_start.md | 11 +---
5 files changed, 56 insertions(+), 59 deletions(-)
diff --git a/docs/en-us/modules/agent/img/architecture.png b/docs/en-us/modules/agent/img/architecture.png
new file mode 100644
index 0000000..1138fe1
Binary files /dev/null and b/docs/en-us/modules/agent/img/architecture.png differ
diff --git a/docs/en-us/modules/agent/quick_start.md b/docs/en-us/modules/agent/quick_start.md
index cdbdb9b..985c249 100644
--- a/docs/en-us/modules/agent/quick_start.md
+++ b/docs/en-us/modules/agent/quick_start.md
@@ -1,19 +1,25 @@
## 1、install
+ env requirements：
+ java JDK 1.8
+ Maven 3.6 +
+
+
mvn clean package -DskipTests
- The tgz installation package can be found in the target under the project
+ The tgz installation package can be found in the target under the agent-release
## 2、Configuration
-###2.1 Agent configuration
-
The agent supports two modes of operation: local operation and online operation
+
+###2.1 Agent configuration
+
Online operation needs to pull the configuration from inlong-manager, the configuration conf/agent.properties is as follows:
-agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）
+agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (the class name for fetch tasks, default ManagerFetcher）
agent.local.ip=Write local ip
agent.manager.vip.http.host=manager host
agent.manager.vip.http.port=manager port
@@ -31,8 +37,8 @@ Create a new directory jobs in conf,
vim job1.json：
put
- {
-
+{
+
"job": {
"dir": {
diff --git a/docs/en-us/modules/dataproxy/quick_start.md b/docs/en-us/modules/dataproxy/quick_start.md
index 3abdc59..f98748f 100644
--- a/docs/en-us/modules/dataproxy/quick_start.md
+++ b/docs/en-us/modules/dataproxy/quick_start.md
@@ -14,8 +14,8 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
### config tube
vim conf/flume.conf
- In vim command line mode, execute the following replacement commands, where xxx is the tube address
- :%s/TUBE_LIST/xx.xx.xx.xx:port,xx.xx.xx.xx:port
+ In vim command line mode, execute the following replacement commands, where ip:port is the tube address
+ :%s/TUBE_LIST/ip:port,ip:port
### Environmental preparation
cd bin
@@ -24,7 +24,7 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
### config manager
vim conf/commmon.properties
- 写入以下配置：
+ write：
cluster_id=1
manager_hosts=xx.xx.xx.xx:port
@@ -34,7 +34,3 @@ The tgz installation package apache-inlong-proxy-0.9.0-incubating-SNAPSHOT-bin.t
## 4、check
telnet 127.0.0.1 46801
-## 5、test
- use proxySdk to test
-
-
diff --git a/docs/zh-cn/modules/agent/quick_start.md b/docs/zh-cn/modules/agent/quick_start.md
index 419f0bd..c387c0f 100644
--- a/docs/zh-cn/modules/agent/quick_start.md
+++ b/docs/zh-cn/modules/agent/quick_start.md
@@ -1,19 +1,23 @@
-
##一、安装
+ 环境要求：
+ java JDK 1.8
+ Maven 3.6 +
+
+ inlong目录下执行命令
mvn clean package -DskipTests
- 在项目下的target里面可以找到tgz安装包
-
+ 在项目下的agent-release/target里面可以找到tgz安装包
-## 二、配置
-###2.1 Agent 相关设置
+## 二、配置
agent 支持两种运行模式：本地运行以及线上运行
+###2.1 Agent 线上运行相关设置
+
线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：
agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher (设置任务获取的类名，默认为ManagerFetcher）
agent.local.ip=写入本机ip
@@ -27,7 +31,7 @@ agent.manager.vip.http.port=manager port
{"cluster_id":45,"isInterVisit":1,"size":1,"address": [{"port":写入proxy port,"host":"写入proxy ip"}], "switch":0}
-###2.3 本地 job配置
+###2.3 agent本地运行job配置
如果不使用线上模式，可以使用本地文件新建读取任务
在conf中新建目录jobs，
vim job1.json：
@@ -89,41 +93,37 @@ vim job1.json：
# http default port
agent.http.port=可用端口
- curl --location --request POST 'http://localhost:8129/config/job' \
- --header 'Content-Type: application/json' \
- --data '{
- "job": {
- "dir": {
- "path": "",
- "pattern": "/data/inlong-agent/test.log"
- },
- "trigger": "org.apache.inlong.agent.plugin.trigger.DirectoryTrigger",
- "id": 1,
- "thread": {
- "running": {
- "core": "4"
- },
- "onejob": true
- },
- "name": "fileAgentTest",
- "source": "org.apache.inlong.agent.plugin.sources.TextFileSource",
- "sink": "org.apache.inlong.agent.plugin.sinks.TdBusSink",
- "channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
- },
- "bus": {
- "bid": "thirtybid10",
- "tdmanager": {
- "port": "8099",
- "host": "http://tl-tdbank-tdmanger.tencent-distribute.com"
- }
- },
- "op": "add"
- }'
+curl --location --request POST 'http://localhost:8129/config/job' \
+--header 'Content-Type: application/json' \
+--data '{
+"job": {
+"dir": {
+"path": "",
+"pattern": "/data/inlong-agent/test.log"
+},
+"trigger": "org.apache.inlong.agent.plugin.trigger.DirectoryTrigger",
+"id": 1,
+"thread": {
+"running": {
+"core": "4"
+}
+},
+"name": "fileAgentTest",
+"source": "org.apache.inlong.agent.plugin.sources.TextFileSource",
+"sink": "org.apache.inlong.agent.plugin.sinks.TdBusSink",
+"channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
+},
+"proxy": {
+"bid": "thirtybid10"
+},
+"op": "add"
+}'
其中参数分别为：
- op:
+ pattern: 代表读取/data/inlong-agent/test.log文件
+ proxy.bid: 代表发送到proxy使用的bid
##三、运行
解压后如下命令运行
- sh agent.sh start
+ sh agent.sh start
\ No newline at end of file
diff --git a/docs/zh-cn/modules/dataproxy/quick_start.md b/docs/zh-cn/modules/dataproxy/quick_start.md
index dfc65d4..337ab40 100644
--- a/docs/zh-cn/modules/dataproxy/quick_start.md
+++ b/docs/zh-cn/modules/dataproxy/quick_start.md
@@ -1,6 +1,4 @@
-
-
-##一、安装
+## 一、安装
mvn clean package -DskipTests
@@ -16,8 +14,8 @@
### 配置tube地址
vim conf/flume.conf
- vim命令行模式，执行以下替换命令,其中xxx为tube地址
- :%s/TUBE_LIST/xx.xx.xx.xx:port,xx.xx.xx.xx:port
+ vim命令行模式，执行以下替换命令,其中ip:port为tube master地址，可配置多个
+ :%s/TUBE_LIST/ip1:port,ip2:port
### 环境准备
cd bin
@@ -36,7 +34,4 @@
## 四、检查启动情况
telnet 127.0.0.1 46801
-## 五、测试
- 使用proxySdk发送数据测试
-