# red-octopus

**Repository Path**: juque-framework/red-octopus

## Basic Information

- **Project Name**: red-octopus
- **Description**: 红章鱼日志平台
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-11
- **Last Updated**: 2021-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# red-octopus

#### 介绍
红章鱼日志采集平台

#### 软件架构
软件架构说明
>red-octopus
>>red-octopus-api ----------------放置DTO、枚举<br>
>>red-octopus-client -------------红章鱼客户端<br>
>>red-octopus-manager --------解析日志并存储到elasticsearch<br>
>>red-octopus-server ------------放置单测及启动类<br>

#### 安装教程

1.  客户端添加red-octopus-client依赖<br>
```xml
  <dependency>
      <groupId>cn.juque</groupId>
      <artifactId>red-octopus-client</artifactId>
      <version>1.0-SNAPSHOT</version>
      <exclusions>
        <exclusion>
          <artifactId>spring-boot-starter-log4j2</artifactId>
          <groupId>org.springframework.boot</groupId>
        </exclusion>
      </exclusions>
    </dependency>
```
2.  客户端application-*.yml文件添加rabbitmq配置<br>
```yaml
spring:
  rabbitmq:
    host: 127.0.0.1  
    port: 5672
    username: rabbit-mq
    password: 1234567
    listener:
      direct:
        acknowledge-mode: manual
      simple:
        acknowledge-mode: manual
    topic-exchange: octopus-log
```
3.  日志配置添加appender：logback添加OctLogbackAppender，log4j2添加OctLog4j2Appender<br>
```xml
 <appender name="OctLogback" class="cn.juque.redoctopus.client.appender.OctLogbackAppender">
    <serviceNo>001</serviceNo>
    <serviceName>system-service</serviceName>
    <level>INFO</level>
  </appender>
```
#### 使用说明

1.  框架已实现logback、log4j2的appender，可根据实际情况自定义实现appender；
2.  日志存放依赖lucene介质，客户端与服务端依赖rabbitmq实现日志的传递；
3.  disruptor环形空间大小必须是2的N次方，该变量可在DisruptorConfigurer自定义调整；
4.	前端：red-octopus-serve启动成功后，访问路径：http:// 127.0.0.1:8080/index.html；
5.  红章鱼的实现依赖lucene-plus: https://gitee.com/juque-framework/lucene-plus
6.  红章鱼服务端的依赖包可前往下载：https://gitee.com/juque-framework/juque-dependencies

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)