# components-starter-sentry

**Repository Path**: codealy/components-starter-sentry

## Basic Information

- **Project Name**: components-starter-sentry
- **Description**: sentry 的快速启动
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-09-27
- **Last Updated**: 2022-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## components-starter-sentry

### 介绍
sentry 的快速启动

### 软件架构
服务异常信息组件 sentry 的 启动配置，集成至 .properties/.yml/各个配置中心中


### 使用说明
#### 1.  添加依赖
```aidl
<dependency>
    <groupId>com.whosly.spring.cloud</groupId>
    <artifactId>components-starter-sentry</artifactId>
    <version>xxx</version>
</dependency>
```

#### 2.  sentry 配置属性
该配置可以存在于 .properties/.yml/各个配置中心中。

配置项按需选择。<br>
dsn 必须配置。
```aidl

sentry:
  # 是否启用
  enable: true
  # dsn 数据源设置
  dsn: http://211dc184a16f4e09830c5a3111812bc3@localhost:9000/2
  sampleRate: 1
  tracesSampleRate: 1
  debug: false
  release: my-project-name@2.5
  environment: local
  shutdownTimeout: 2000
  flushTimeoutMillis: 15000
  connectionTimeoutMillis: 5000
  readTimeoutMillis: 5000
  maxBreadcrumbs: 100
```

#### 3.  日志配置
以日志文件  logback.xml 举例

> 新增 appender：
`
<include resource="com/whosly/spring/cloud/components/starter/sentry/include.xml"/>
`

> 按需在logger 中新增 appender-ref：
`<appender-ref ref="Sentry"/>`

例子：
https://gitee.com/whosly/whosly-example/blob/master/components-starter-sentry-example/src/main/resources/logback.xml

#### 4. example：
https://gitee.com/whosly/whosly-example/tree/master/components-starter-sentry-example


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


### 版本
#### 1.0.5-SNAPSHOT/1.0.5
原配置文件 sentry.property  调整为 spring yml 或者配置中心配置。