# sea-report

**Repository Path**: seaxlab/sea-report

## Basic Information

- **Project Name**: sea-report
- **Description**: 指标上报、告警通知（钉钉、飞书、企业微信）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-14
- **Last Updated**: 2026-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sea Report

## 背景

系统运行过程中，针对业务或系统异常情况进行监控和报警，能够记录当时运行的关键信息，如TID，业务ID等等，从而进行上报处理，如发送钉钉消息、发送飞书消息等等，因此有了这个项目。

## 适用场景

- 推送/上报数据信息(普通信息、堆栈、TID)

## 效果

![](doc/image1.png)

## 使用

### POM

````
  <dependency>
    <groupId>io.github.seaxlab</groupId>
    <artifactId>sea-report-boot-starter</artifactId>
    <!--请取最新版本-->
    <version>x.y.z</version>
  </dependency>
````

### application.yaml

````
# 区域，多机房场景使用，如shanghai、beijing等等
sea.region=ShangHai
# 环境，如dev,sit,pre,pro
sea.env=pro
# 启用report功能
sea.report.enabled=true
# 应用名称
sea.report.endpoint= ${spring.application.name}
# fei-shu/ding-ding/log
sea.report.mode=fei-shu
# im access token
sea.report.imAccessToken=xxx
# 是否聚合消息
sea.report.send.aggregation.enabled=true
# xxl-job
sea.report.xxl-job.enabled=true
# log.error
sea.report.log-error-flag=true
# mybatis  // from 1.7.2
sea.report.mybatis.enabled=true
````

### logback.xml(可选)

````
<!-- report appender -->
<appender name="REPORT_APPENDER" class="com.github.seaxlab.report.plugin.logback.ReportAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<!-- business system -->
<logger name="com.yourcompany.project" level="INFO" additivity="true">
    <appender-ref ref="REPORT_APPENDER"/>
</logger>
````

### API

- Report.logMetric 告警消息
- Report.sendMessage 一般消息
- Report.sendTableMessage 表格消息

### 示例

````
MetricDTO metricDTO = new MetricDTO(BizMetricEnum.ORDER_CREATED_FAIL);
metricDTO.addTag("contractCode", "1000");
metricDTO.setRemark("调用xx失败");
Report.logMetric(metricDTO);
````