# TailLog-Agent

**Repository Path**: Donaldhans/TailLog-Agent

## Basic Information

- **Project Name**: TailLog-Agent
- **Description**: 配合TailLog工具（实时日志管理查看工具）使用的代理服务程序
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://www.taillog.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 23
- **Created**: 2020-04-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TailLog-Agent

配合TailLog（实时日志查看监控工具）使用的代理服务程序（Java版）

![](image/agent.png)

#### 了解TaiLog——实时日志查看监控工具

<a href="http://www.taillog.cn">TailLog首页</a>

<a href="https://gitee.com/no7player/TeamStack">TailLog码云</a>


### 一.功能作用：

1. 该程序主要实现两个功能：

* 通过ssh协议访问日志服务器并读取日志

* 提供WebSocket服务，输出日志信息

2.其基本结构如下：

PC <----> 代理服务器 <----> 日志服务器

TailLog <----> Agent <----> 日志文件

3.主要技术栈

* <a href="http://projects.spring.io/spring-boot/">Spring Boot</a>

* WebSocket

* <a href="http://www.jcraft.com/jsch/">JSch</a>

### 二.部署

* Step-1: 下载最新发布jar包

<a href="https://github.com/djmpink/TailLog-Agent/releases/download/1.0.0/taillog-agent-1.0.0.jar">taillog-agent-1.0.0.jar</a>

* Step-2: 在运行目录下，添加配置文件

config.properties

````
#服务端口
server.port=10091

#默认ssh配置 服务日志（被代理）文件所在地址
ssh.server.log.ip=192.168.230.129
ssh.server.log.port=22
ssh.server.log.username=donaldhan
ssh.server.log.password=123456

# 认SSH验证方式, 支持方式
# default，默认SSH验证方式，密码认证
# keysFile，SSH私钥验证
ssh.session.verify=default

# 如果ssh验证方式为keystore， 则此属性必须配置，为私钥路径
ssh.session.keys.file.path=/home/donaldhan/id_rsa
ssh.session.keys.passphrase=123456

````

* Step-3: 运行

````
java -jar taillog-agent-2.1.0.jar --spring.config.location=config.properties
````

守护方式启动

```
nohup java -jar taillog-agent-2.1.0.jar --spring.config.location=config.properties > logs/log_out.log 2>&1 &
```

### 三.使用源码打包

配置内容和方式同上

```
$ mvn package -Dmaven.test.skip=true  
$ mvn install
```

### 四.接口说明

开发人员可以根据以下接口说明使用其他语言自行实现代理程序

* WebSocket访问地址：
````
ws://{ip}:{port}/websocket
````

默认端口：10091


* 连接参数：
````
{
    "ssh": {
        “verify"="default"
        "ip":"192.168.230.129",
        "port":"22",
        "username":"donaldhan",
        "password":"123456",
        "keysFilePath":"/home/donaldhan/id_rsa",
        "keysPassphrase":"123456"
    },
    "content": "/home/project/app.log" 
}
````
参数说明：

ssh：[选填] 被代理的服务器IP地址。客户端可以通过配置该信息指定访问的服务器。未填则使用代理配置的服务器信息

content：[必填] 待执行的linux命令。客户端将发送"tail..."等命令获取日志内容


具体参考ws文件：*wslog.html*
[wslog](/src/main/resources/wslog.html)



### 日志下载
访问如下url即可
```
http://{ip}:{port}/api/log/download?path=F%3A%5Clogs%5Cerror.log
``` 
**注意路径含有特殊字符需要编码**