6.29 版本
发送流程
默认实现核心类 AsyncHttpTransport 实现 ITransport, 主要用于日志的异步发送, 其他可供参考的有 : NoOpTransport 和 StdoutTransport
AsyncHttpTransport 核心组件
- transportGate: 默认为 NoOpTransportGate , 可以加上服务注册用于选择不同服务器, 或实现不同配置的路由
- envelopeCache: 默认为 NoOpEnvelopeCache, 有 store 和 discard 方法, 可以用于监控发送情况
- executor: 线程池, 默认为 core : 1, max: 1, quque: 30 的队列, 拒绝策略记录 warn 日志, 如果有 envelopeCache, 通过 Hint 记录
- rateLimiter: 限流器
- connection: 实际发送类 HttpConnection
断点位置 AsyncHttpTransport#send 方法,调用链路如下
最终通过 EnvelopeSender 内部类 提交到线程池执行
final Future<?> future =
executor.submit(
new EnvelopeSender(envelopeThatMayIncludeClientReport, hint, currentEnvelopeCache));
最终调用到 EnvelopeSender#flush 方法 ,实际调用 HttpConnection 进行远程调用
TransportResult result = this.failedResult;
envelope.getHeader().setSentAt(null);
envelopeCache.store(envelope, hint);
...
result = connection.send(envelopeWithClientReport);
if (result.isSuccess()) {
envelopeCache.discard(envelope);
}
...
发送成功后返回 SuccesTransportResult
发送的基本单元 SentryEnvelope 包含以下字段
初始化
初始化通过设置断点 Sentry#init 方法上实现链路追踪
默认初始化模式
初始化断点可以额
- Sentry.init 通过 logback 的 LogbackLoggingSystem 触发, 将各种 Appender 调用 start 进行初始化, 这里是 SentryAppender
- SentryOptions 是通过 new SentryOptions() 创建, 在 Sentry#initConfigurations 方法来读取 sentry.properties, 通过 SentryOption#merge 方法来完成合并
- SentryOption#merge 属性的提供方为 CompositePropertiesProvider (SystemPropertyPropertiesProvider -> EnvironmentVariablePropertiesProvider -> SimplePropertiesProvider(指定路径, classpath, 当前目录中读取 sentry.properties)), 具体看 PropertiesProviderFactory#create
public class SentryAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
public void start() {
// NOTE: logback.xml properties will only be applied if the SDK has not yet been initialized
if (!Sentry.isEnabled()) {
...
Sentry.init(options);
}
}
}
SpringBoot 初始化
spring boot 初始化是在 SentryAppender "默认初始化" 完成之后进行的, 会再次的进行 Sentry.init , 会覆盖首次配置
初始化入口位于 : ServletWebServerApplicationContext, 需要初始化的 filter 包含: sentryUserFilter, sentrySpringFilter, sentryTracingFilter, 来完成在 spring mvc 中添加filter 的目的
其他小知识: sentryUserFilter 通过 FilterRegistrationBean 类的包装, 并实现 ServletContextInitializer 接口来完成 ServletWebServerApplicationContext 的初始化, 说简单点就是注册 Filter
初始化 sentryUserFilter 的处理依赖时会初始化 sentryHub, 再到 Sentry.OptionsConfiguration(扩展点), 实际配置通过 SentryProperties (EnableConfigurationProperties 模式) 注入
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(SentryProperties.class)
@Open
static class HubConfiguration {
@Bean
public @NotNull IHub sentryHub(final @NotNull SentryProperties options) {
// 处理 git, client 名称, 扩展点sentryOptionsConfiguration 的处理
...
Sentry.init(options);
return HubAdapter.getInstance();
}
}
Sentry.OptionsConfiguration <sentryoptions>为扩展点, 可以自行定义 sentryOptionsConfiguration 来自定义一些操作</sentryoptions>
实现 IHub 接口的 HubAdapter 仅仅为 Sentry 的适配器类, 等同于 Sentry 类 , 初始化完成
@EnableSentry
@Import({SentryHubRegistrar.class, SentryInitBeanPostProcessor.class, SentryWebConfiguration.class})
@Target(ElementType.TYPE)
public @interface EnableSentry {}
旧版本实现逻辑
1.7 版本初始化
调用链, Sentry 的初始化通过静态方法触发, 如果自己没写, 则通过 SentryAppender 实际调用时触发
配置读取主要通过 Lookup 实现, Lookup 中有两组用于提供配置的 Provider
highPriorityProvider : 高优先级
JndiConfigurationProvider: 读取 java:comp/env/sentry/ 下的配置
SystemPropertiesConfigurationProvider: 读取系统属性 sentry. 前缀变量
EnvironmentConfigurationProvider: 读取环境变量, 读取 SENTRY_ (变量名.replace(".","_").Upper), 例如 dsn -> SENTRY_DSN
lowPriorityProvider; 包含获取当前目录下文件 或 classPath 下的sentry.properties,
FileResourceLoader: 文件读取
ContextClassLoaderResourceLoader: classPath 下读取
读取流程, 先通过 lowPriorityProvider 读取出整个配置文件, 实际使用时再通过 highPriorityProvider 中的配置读取
1.7 版本发送逻辑
几个关键组件
SentryClient
Connection: 分两种
包装类 Connection: 用于实际处理类的包装
AsyncConnection: 异步处理类 (默认)
BufferedConnection: 提供本地磁盘保存的处理 (通过包装 AsyncConnection) 实现
实际处理 Connection: 继承 AbstractConnection , 实现有
http
noop
OutputStream
SentryClientFactory: 用于构造 Connection, 并创建 SentryClient
核心断点位置 DefaultSentryClientFactory#createConnection
异步Connection 创建流程
1. 读取当前队列长度 (默认 50 )
2. 创建 50 长度的LinkedBlockingDeque
3. 创建core和 maxSize 等于当前机器cpu 核数一样大的 ThreadPoolExecutor
4. 默认拒绝策略为: 丢弃旧的, 实现方式为从 queue 中 poll 一个, 塞入新的
REJECT_EXECUTION_HANDLERS.put(ASYNC_QUEUE_SYNC, new ThreadPoolExecutor.CallerRunsPolicy());
REJECT_EXECUTION_HANDLERS.put(ASYNC_QUEUE_DISCARDNEW, new ThreadPoolExecutor.DiscardPolicy());
REJECT_EXECUTION_HANDLERS.put(ASYNC_QUEUE_DISCARDOLD, new ThreadPoolExecutor.DiscardOldestPolicy());
发送逻辑 AsyncConnection#send, 通过 内部类 EventSubmitter 调用 HttpConnection
