# TailLog

**Repository Path**: liuhuayun/TeamStack

## Basic Information

- **Project Name**: TailLog
- **Description**: 实时日志（tail log）查看监控客户端工具
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://www.taillog.cn/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 25
- **Created**: 2022-12-04
- **Last Updated**: 2022-12-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

What Is It?
-----------

[TailLog](http://www.taillog.cn/)是一款实时日志查看监控客户端工具。用于快速高效的查看和监控本地或远程的日志文件。 
类似命令"tail"，在本地展示并跟踪日志信息。 
通过过滤器，搜索，高亮等辅助等功能，快定位异常，让你更专注于程序开发与运行。
<p align="center">
	<a href="http://www.taillog.cn">官网首页</a> ·
	<a href="https://djmpink.github.io/TailLog/">Documentation</a>
</p>
<p align="center">
<a href="https://pan.baidu.com/s/1hs09q8s" style="color: #cccccc">百度网盘</a>
</p>
<p align="center">
<a href="https://github.com/djmpink/TailLog-Source" style="color: #cccccc">开源代码</a>
</p>

![](images/display.gif)


# 开源计划 与 备注
#### 源码已开源 [TailLog-Source](https://github.com/djmpink/TailLog-Source)。
#### 欢迎反馈意见，完善产品。
#### 同样欢迎感兴趣者一起参与。
#### 交流沟通群：455735429

# 近期迭代计划

1.完善代理方式，提供示例程序（java，go，nodejs）与文档

2.稳定与安全性优化

# 简介
开发工作总是需要和日志打交道。而在开发，调试，监控时最常使用的命令是“tail -f xxx.log”来实时了解日志信息。但每次查看日志总是需要打开命令行工具，登录服务器，找到日志文件。
另外，在分布式，微服务的潮流下导致日志数量增多，分散。如果考虑到不同的环境（如开发，测试，生产等）又将成倍增加。
因此，TailLog希望通过在线服务，存储配置信息，将日志信息有效集中化管理。简化操作过程，做到随时快速看到日志流动信息，提高工作效率和质量。

# 工作方式
TailLog通过远程连接至日志所在服务器，根据所配置的日志文件信息获取日志实时内容并将其输出到客户端。
TailLog目前主要提供两种远程连接方式：SSH方式和代理方式。
1.SSH方式
客户端根据配置的ssh信息通过ssh协议直接登录服务器。
该方式配置简单，使用方便。并且因为是直接访问，执行效果较好。
但缺点是需要使用服务器用户名和密码，有些环境可能无法提供或了解该信息。
2.代理方式
通过部署代理程序，实现标准接口，由代理程序访问日志信息，然后再通过WebSock方式实时输出到客户端。
该方式存在转发过程，中间可能经过两次网络传输，速度可能不及ssh方式。另外还需要配置部署代理程序，存在使用门槛。
有点是代理程序可自定义，可拓展，比如可以对日志进行聚合，存储等操作。屏蔽服务器账户信息，对接更多场景。

代理程序接口与实现文档参考：

<a href="https://github.com/djmpink/TailLog-Agent"> 代理示例部署程序（JAVA版）</a>

# 使用帮助

## 安装
#### Mac版

<p align="center">
	<a href="https://github.com/djmpink/log-dashboard/releases/download/1.0.0-20171130/TailLog.dmg">Download</a>
</p>
点击安装包 TailLog.dmg 执行安装。

### Windows版

<p align="center">
	<a href="https://github.com/djmpink/log-dashboard/releases/download/1.0.0-20171130/TailLog-win32-x64.zip">Download</a>
</p>
下载后解压，运行：TailLog.exe

### 百度网盘
<p align="center">
<a href="https://pan.baidu.com/s/1hs09q8s" style="color: #cccccc">百度网盘</a>
</p>


## 用户相关
1.登录

支持：邮箱登录，三方登录（QQ，github）

2.注册

填写注册邮箱-->点击“注册”-->发送注册验证邮件-->进入邮箱点击“验证链接”-->验证成功-->登录

3.找回/修改密码

忘记密码-->填写注册邮件-->发送找回密码邮件-->进入邮箱点击“重置密码”-->设置新密码-->重新登录

用户设置页-->修改密码-->填写旧密码与新密码-->点击“重置密码”-->发送重置密码邮件-->进入邮箱点击“重置密码”-->重新登录

4.绑定/修改邮箱

用户设置页-->修改邮箱-->填写邮箱-->点击“设置”-->发送绑定邮件-->进入邮箱点击“绑定邮箱”

5.修改昵称

用户设置页-->修改昵称

### 配置相关
1.配置管理

（1）日志配置列表

![](images/80469853.png)

（2）SSH配置列表

![](images/80482607.png)

（3）代理配置

![](images/80527551.png)


3.配置SSH

（1）切换为“SSH配置”标签页，点击“+”新增SSH配置

![](images/80227938.png)

（2）编辑ssh账户信息

![](images/80352362.png)

（3）测试连接状态

![](images/80393482.png)


（4）点击保存

4.配置代理

（1）切换为“代理配置”标签页，点击“+”新增代理配置

![](images/80570389.png)

（2）配置代理程序信息

![](images/80650488.png)

（3）点击“测试连接”，测试访问状态

（4）点击“保存”

4.配置日志文件

（1）切换为“日志管理”标签页，点击“+”新增代理配置

![](images/80857396.png)

（2）左侧切换配置方式（SSH/代理/文件）以配置SSH为例：

在下拉列表中选对应服务器ssh配置
配置日志信息，如日志名称，日志文件路径等。

![](images/80979829.png)

（3）点击保存

### 实时日志
1.查看实时日志

（1）点击列表中“查看”，或者“双击”该行，进入日志显示页。

![](images/81242242.png)


（2）进入为“关闭”状态，点击右上方“开关切换”按钮开启日志显示：

![](images/81418741.png)

2.辅助功能
* 快速切换日志

![](images/81555394.png)

* 关键词搜索/关键词高亮

输入关键词，日志信息中将自动高亮该内容。键盘回车将执行全文关键词搜索功能，类似执行“ grep 'keyworks' xxx.log ”

![](images/81750997.png)

* 命令行

功能运行输入linux命令行命令，并将在其对应的日志目录下执行该命令。可根据需要灵活使用。

![](images/82094323.png)

* 清空屏幕

该功能将清空当前屏幕信息。

![](images/81968581.png)


## 更新日志

* 2017 10.24 

    v1.0.0 预览版发布
    
* 2017 11.10 

   （1）新增日志分组
    
   （2）新增命令行工具 *BETA版*
    
   （3）更换应用名称：TeamStack -> TailLog
   
* 2017 11.21
    
    v1.0.0-20171121 本地离线版发布
    
    支持免登陆使用，数据本地存储。
    
    支持本地配置数据导入导出，方便备份与分享。
    
* 2017 11.30
        
    v1.0.0-20171130 日志监控窗口多开显示
    
    支持同时查看多个日志内容
    
    配置日志路径支持直接目录操作
    
* 2017 12.04
    
    v1.0.0-20171204 代理方式优化
            
    <a href="https://github.com/djmpink/TailLog-Agent"> 提供代理示例部署程序（JAVA版）</a>

## 开发者信息

博客 | <a href="http://7player.cn">7号球员</a>

Github : <a href="https://github.com/djmpink">https://github.com/djmpink</a>

QQ : 343787567

## 鼓励前行

| 支付宝        | 微信           | 
| ------------- |:-------------:| 
|![](images/alipay2.png)|![](images/weipay2.png)|