Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INLONG-1119][Doc] Fix Quick Start Chapter #1109

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -76,12 +76,12 @@ Back to [Ingestion] page, wait for [configuration success].

## Test Data
### Enter Agent Container
```
```shell
docker exec -it agent /bin/bash
```

### Send Data
```
```shell
# collect file /data/collect-data/test.log data source configuration path and total of 10000 data packets are sent.
for i in {1..10000};do echo "name_$i | $i" >> /data/collect-data/test.log;done
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ docker run -d --name kafka -p 9092:9092 -e KAFKA_BROKER_ID=0 -e KAFKA_ZOOKEEPER_

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down
4 changes: 2 additions & 2 deletions docs/quick_start/offline_data_sync/airflow_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Download the [connectors](https://inlong.apache.org/downloads/) corresponding to

## Create Clusters And Data Target
When all containers are successfully started, you can access the InLong dashboard address `http://localhost`, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand All @@ -37,7 +37,7 @@ Password: inlong

Execute the following SQL statement:

```mysql
```sql
CREATE TABLE sink_table (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
Expand Down
26 changes: 13 additions & 13 deletions docs/quick_start/offline_data_sync/dolphinscheduler_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Download the [connectors](https://inlong.apache.org/downloads/) corresponding to

## Create Clusters And Data Target
When all containers are successfully started, you can access the InLong dashboard address `http://localhost`, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand All @@ -40,7 +40,7 @@ Password: inlong

Execute the following SQL statement:

```mysql
```sql
CREATE TABLE sink_table (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
Expand Down Expand Up @@ -112,17 +112,17 @@ View the DolphinScheduler task instance logs. The following logs indicate that t
Use the Pulsar SDK to produce data into the Pulsar topic. An example is as follows:

```java
// Create Pulsar client and producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// Send messages
for (int i = 0; i < 10000; i++) {
// Field separator is |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
// Create Pulsar client and producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// Send messages
for (int i = 0; i < 10000; i++) {
// Field separator is |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
```

### Data Validation
Expand Down
32 changes: 18 additions & 14 deletions docs/quick_start/offline_data_sync/quartz_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Download the [connectors](https://inlong.apache.org/downloads/) corresponding to

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address `http://localhost`, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand All @@ -29,13 +29,17 @@ Click [Clusters] -> [ClusterTags] -> [Create] on the page to specify the cluster

![Create Cluster Tag](img/pulsar_mysql/quartz/cluster_tag.png)

**caution: `default_cluster` is the default ClusterTags for each component. If you decide to use a different name, make sure to update the corresponding tag configuration accordingly.**
:::caution
`default_cluster` is the default ClusterTags for each component. If you decide to use a different name, make sure to update the corresponding tag configuration accordingly.
:::

### Register Pulsar Cluster

![Create Pulsar](img/pulsar_mysql/quartz/create_pulsar_cluster.png)

**You can refer to the screenshot information to fill in details such as cluster name, associated tag, and Pulsar cluster address.**
:::info
You can refer to the screenshot information to fill in details such as cluster name, associated tag, and Pulsar cluster address.
:::

## Task Creation
### Create Data Stream Group
Expand Down Expand Up @@ -115,17 +119,17 @@ Return to the [Synchronization] page and wait for the task configuration to succ

Use the Pulsar SDK to produce data into the Pulsar topic. An example is as follows:
```java
// Create Pulsar client and producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// Send messages
for (int i = 0; i < 10000; i++) {
// Field separator is |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
// Create Pulsar client and producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// Send messages
for (int i = 0; i < 10000; i++) {
// Field separator is |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
```

### Data Validation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down
4 changes: 2 additions & 2 deletions docs/quick_start/realtime_data_sync/mysql_iceberg_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please refer to the [Installation Tutorial](https://iceberg.apache.org/hive-quic

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -67,7 +67,7 @@ Back to [Synchronization] page, wait for [success].

## Test Data
### Send Data
```
```bash
#!/bin/bash

# MySQL info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Please refer to the [Installation Tutorial](https://docs.starrocks.io/docs/quick

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -64,7 +64,7 @@ Back to [Synchronization] page, wait for [success].

## Test Data
### Send Data
```
```bash
#!/bin/bash

# MySQL info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## Cluster Initialize
When all containers are successfully started, you can access the InLong dashboard address http://localhost, and use the following default account to log in.
```
```properties
User: admin
Password: inlong
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## 集群初始化
容器启动成功后,访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -73,12 +73,12 @@ Service URL 为 `pulsar://pulsar:6650`,Admin URL 为 `http://pulsar:8080`。

## 测试数据
### 进入 Agent 容器
```
```shell
docker exec -it agent /bin/bash
```

### 发送数据
```
```shell
# 采集文件 /data/collect-data/test.log 数据源配置路径,总共发送 10000 条
for i in {1..10000};do echo "name_$i | $i" >> /data/collect-data/test.log;done
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ docker run -d --name kafka -p 9092:9092 -e KAFKA_BROKER_ID=0 -e KAFKA_ZOOKEEPER_

## 集群初始化
容器启动成功后,访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sidebar_position: 3

## 创建集群和数据目标
InLong 服务启动后,可以访问 InLong Dashboard 地址 `http://localhost`,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand All @@ -36,7 +36,7 @@ Password: inlong

执行如下 Sql 语句:

```mysql
```sql
CREATE TABLE sink_table (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ sidebar_position: 2

## 创建集群和数据目标
InLong 服务启动后,可以访问 InLong Dashboard 地址 `http://localhost`,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand All @@ -38,7 +38,7 @@ Password: inlong

执行如下 Sql 语句:

```mysql
```sql
CREATE TABLE sink_table (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(255) NOT NULL,
Expand Down Expand Up @@ -111,17 +111,17 @@ CREATE TABLE sink_table (
通过 Pulsar SDK 生产数据写入的 Pulsar topic 中,示例如下:

```java
// Create Pulsar client and producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// Send messages
for (int i = 0; i < 10000; i++) {
// Field separator is |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
// 创建 pulsar client producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// 发送消息
for (int i = 0; i < 10000; i++) {
// 字段分隔符为 |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
```

### 数据验证
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sidebar_position: 1

## 集群初始化
InLong 服务启动后,可以访问 InLong Dashboard 地址 `http://localhost`,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -113,17 +113,17 @@ CREATE TABLE sink_table (

通过 Pulsar SDK 生产数据写入的 Pulsar topic 中,示例如下:
```java
// 创建 pulsar client 和 producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// 发送消息
for (int i = 0; i < 10000; i++) {
// 字段分隔符为 |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
// 创建 pulsar client 和 producer
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl("pulsar://localhost:6650").build();
Producer<byte[]> producer = pulsarClient.newProducer().topic("public/default/test").create();

// 发送消息
for (int i = 0; i < 10000; i++) {
// 字段分隔符为 |
String msgStr = i + "|msg-" + i;
MessageId msgId = producer.send(msgStr.getBytes(StandardCharsets.UTF_8));
System.out.println("Send msg : " + msgStr + " with msgId: " + msgId);
}
```

### 数据验证
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## 集群初始化
当所有容器都成功启动后,可以访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ sidebar_position: 3

## 集群初始化
容器启动成功后,访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -67,7 +67,7 @@ Password: inlong

## 测试数据
### 发送数据
```
```bash
#!/bin/bash

# MySQL info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ sidebar_position: 2

## 集群初始化
容器启动成功后,访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down Expand Up @@ -61,7 +61,7 @@ Password: inlong

## 测试数据
### 发送数据
```
```shell
#!/bin/bash

# MySQL info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e CLIC

## 集群初始化
当所有容器都成功启动后,可以访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
```
```properties
User: admin
Password: inlong
```
Expand Down