Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
quzard committed Nov 20, 2024
1 parent b4943f4 commit fdd31a0
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 24 deletions.
70 changes: 48 additions & 22 deletions docs/cn/installation/logtail-mode.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,79 @@
# LoongCollector 的 Logtail 兼容模式使用指南

目录结构改造说明请参考 [LoongCollector 的 目录结构说明](loongcollector-dir.md)
LoongCollector 提供了 Logtail 兼容模式,可以让您在升级到 LoongCollector 后继续使用原有的 Logtail 配置和数据,实现平滑迁移。本文将详细介绍如何配置和使用这个兼容模式。

## 兼容模式配置说明
> 在开始之前,请先了解 [LoongCollector 的目录结构说明](loongcollector-dir.md)
为确保现有 Logtail 用户能够平滑升级到 LoongCollector,我们提供了完整的兼容模式支持,在兼容模式下,LoongCollector会按照旧的目录结构进行启动:
## 为什么需要兼容模式?

### 主机环境配置
由于 LoongCollector 采用了新的目录结构和配置体系,与原有 Logtail 存在差异,如果您相关的目录文件升级迁移困难,可以选择使用 Logtail 兼容模式。启用兼容模式后,LoongCollector 将:

启用兼容模式有两种方式:
- 保持与 Logtail 相同的目录结构

1. 命令行参数方式:
- 继续使用 Logtail 的自定义目录配置方式

- 继续使用 Logtail 的文件命名格式

## 配置方法

### 1. 主机环境配置

您可以通过以下两种方式之一启用兼容模式:

**方式一:命令行参数**

```bash
./loongcollector --logtail_mode=true
```

2. 环境变量方式:
**方式二:环境变量**

```bash
export logtail_mode=true
./loongcollector
```

### 容器环境配置
### 2. 容器环境配置

此前的 Logtail 容器镜像中,Logtail 运行时目录为 `/usr/local/ilogtail`,而 LoongCollector 运行时目录为 `/usr/local/loongcollector`

在容器环境中使用时,需要
因此,在容器环境中,除了启用兼容模式外,还需要调整目录映射。请按照以下步骤操作

1. 添加环境变量
1. 需要给LoongCollector容器添加环境变量

```bash
logtail_mode=true
```

2. 调整挂载路径映射
2. 需要调整LoongCollector挂载路径映射

- 原路径:`/usr/local/ilogtail`
- 新路径:`/usr/local/loongcollector`

示例配置调整:
将所有 `/usr/local/ilogtail` 路径替换为 `/usr/local/loongcollector`

```plaintext
# 检查点目录
旧路径: /usr/local/ilogtail/checkpoint
新路径: /usr/local/loongcollector/checkpoint
# 常用目录映射示例
数据检查点:
/usr/local/ilogtail/checkpoint → /usr/local/loongcollector/checkpoint
# 配置目录
旧路径: /usr/local/ilogtail/config/local
新路径: /usr/local/loongcollector/config/local
采集配置目录:
/usr/local/ilogtail/config → /usr/local/loongcollector/config
```

通过以上配置,您可以确保现有的 Logtail 配置和数据在升级到 LoongCollector 后能够继续正常运行。
3. 修改容器镜像地址为LoongCollector镜像地址

`sls-opensource-registry-vpc.cn-shanghai.cr.aliyuncs.com/loongcollector-community-edition/loongcollector:版本号`

## 迁移建议

为确保平稳迁移,我们建议您:

1. 先在测试环境进行充分验证

2. 选择业务低峰期进行升级

3. 做好配置和数据的备份

4. 逐步迁移,避免一次性升级所有实例

5. 密切监控日志采集状态

> **注意**: 迁移过程中请确保数据完整性,建议先在测试环境中进行测试,并非高峰期进行升级操作。
35 changes: 33 additions & 2 deletions docs/cn/installation/loongcollector-dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,13 @@ inotify日志:`/opt/loongcollector/run/inotify_watcher_dirs`
LoongCollector 提供以下参数用于自定义各类目录位置:

- `loongcollector_conf_dir`: 配置目录
- `loongcollector_log_dir`: 日志目录

- `loongcollector_log_dir`: 日志目录

- `loongcollector_data_dir`: 数据目录

- `loongcollector_run_dir`: 运行时目录

- `loongcollector_third_party_dir`: 第三方依赖目录

### 配置方式
Expand Down Expand Up @@ -168,17 +172,29 @@ export loongcollector_conf_dir=/custom/path/conf
为简化配置体系,以下原 Logtail 配置项将不再默认支持:

- sls_observer_ebpf_host_path

- logtail_snapshot_dir

- inotify_watcher_dirs_dump_filename

- local_event_data_file_name

- crash_stack_file_name

- check_point_filename

- adhoc_check_point_file_dir

- app_info_file

- ilogtail_config

- ilogtail_config_env_name

- logtail_sys_conf_dir

- ALIYUN_LOGTAIL_SYS_CONF_DIR

- ilogtail_docker_file_path_config

## 升级建议
Expand All @@ -187,8 +203,23 @@ export loongcollector_conf_dir=/custom/path/conf

2. **新版迁移**: 如果选择使用新版目录结构:
- 建议先备份原有配置和数据

- 按新版目录结构迁移文件

- 更新相关配置引用

- 验证服务正常运行

> **注意**: 迁移过程中请确保数据完整性,建议在非高峰期进行升级操作。
为确保平稳迁移,我们建议您:

1. 先在测试环境进行充分验证

2. 选择业务低峰期进行升级

3. 做好配置和数据的备份

4. 逐步迁移,避免一次性升级所有实例

5. 密切监控日志采集状态

> **注意**: 迁移过程中请确保数据完整性,建议先在测试环境中进行测试,并非高峰期进行升级操作。

0 comments on commit fdd31a0

Please sign in to comment.