forked from getsentry/sentry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathISentryClient.java
More file actions
269 lines (243 loc) · 8.38 KB
/
ISentryClient.java
File metadata and controls
269 lines (243 loc) · 8.38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
package io.sentry;
import io.sentry.protocol.Message;
import io.sentry.protocol.SentryId;
import io.sentry.protocol.SentryTransaction;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** Sentry Client interface */
public interface ISentryClient {
/**
* Whether the client is enabled or not
*
* @return true if its enabled or false otherwise.
*/
boolean isEnabled();
/**
* Capture the event
*
* @param event the event
* @param scope An optional scope to be applied to the event.
* @param hint SDK specific but provides high level information about the origin of the event.
* @return The Id (SentryId object) of the event.
*/
@NotNull
SentryId captureEvent(@NotNull SentryEvent event, @Nullable Scope scope, @Nullable Hint hint);
/** Flushes out the queue for up to timeout seconds and disable the client. */
void close();
/**
* Flushes events queued up, but keeps the client enabled. Not implemented yet.
*
* @param timeoutMillis time in milliseconds
*/
void flush(long timeoutMillis);
/**
* Captures the event.
*
* @param event the event
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureEvent(@NotNull SentryEvent event) {
return captureEvent(event, null, null);
}
/**
* Captures the event.
*
* @param event the event
* @param scope An optional scope to be applied to the event.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureEvent(@NotNull SentryEvent event, @Nullable Scope scope) {
return captureEvent(event, scope, null);
}
/**
* Capture the event
*
* @param event the event
* @param hint SDK specific but provides high level information about the origin of the event.
* @return The Id (SentryId object) of the event.
*/
default @NotNull SentryId captureEvent(@NotNull SentryEvent event, @Nullable Hint hint) {
return captureEvent(event, null, hint);
}
/**
* Captures the message.
*
* @param message The message to send.
* @param level The message level.
* @param scope An optional scope to be applied to the event.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureMessage(
@NotNull String message, @NotNull SentryLevel level, @Nullable Scope scope) {
SentryEvent event = new SentryEvent();
Message sentryMessage = new Message();
sentryMessage.setFormatted(message);
event.setMessage(sentryMessage);
event.setLevel(level);
return captureEvent(event, scope);
}
/**
* Captures the message.
*
* @param message The message to send.
* @param level The message level.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureMessage(@NotNull String message, @NotNull SentryLevel level) {
return captureMessage(message, level, null);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureException(@NotNull Throwable throwable) {
return captureException(throwable, null, null);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @param hint SDK specific but provides high level information about the origin of the event
* @param scope An optional scope to be applied to the event.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureException(
@NotNull Throwable throwable, @Nullable Scope scope, @Nullable Hint hint) {
SentryEvent event = new SentryEvent(throwable);
return captureEvent(event, scope, hint);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureException(@NotNull Throwable throwable, @Nullable Hint hint) {
return captureException(throwable, null, hint);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @param scope An optional scope to be applied to the event.
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureException(@NotNull Throwable throwable, @Nullable Scope scope) {
return captureException(throwable, scope, null);
}
/**
* Captures a manually created user feedback and sends it to Sentry.
*
* @param userFeedback The user feedback to send to Sentry.
*/
void captureUserFeedback(@NotNull UserFeedback userFeedback);
/**
* Captures a session. This method transform a session to an envelope and forwards to
* captureEnvelope
*
* @param hint SDK specific but provides high level information about the origin of the event
* @param session the Session
*/
void captureSession(@NotNull Session session, @Nullable Hint hint);
/**
* Captures a session. This method transform a session to an envelope and forwards to
* captureEnvelope
*
* @param session the Session
*/
default void captureSession(@NotNull Session session) {
captureSession(session, null);
}
/**
* Captures an envelope.
*
* @param envelope the SentryEnvelope to send.
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
@Nullable
SentryId captureEnvelope(@NotNull SentryEnvelope envelope, @Nullable Hint hint);
/**
* Captures an envelope.
*
* @param envelope the SentryEnvelope to send.
* @return The Id (SentryId object) of the event
*/
default @Nullable SentryId captureEnvelope(@NotNull SentryEnvelope envelope) {
return captureEnvelope(envelope, null);
}
/**
* Captures a transaction.
*
* @param transaction the {@link ITransaction} to send
* @param scope An optional scope to be applied to the event.
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
@NotNull
default SentryId captureTransaction(
@NotNull SentryTransaction transaction, @Nullable Scope scope, @Nullable Hint hint) {
return captureTransaction(transaction, null, scope, hint);
}
/**
* Captures a transaction.
*
* @param transaction the {@link ITransaction} to send
* @param traceState the trace state
* @param scope An optional scope to be applied to the event.
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
@NotNull
@ApiStatus.Internal
default SentryId captureTransaction(
@NotNull SentryTransaction transaction,
@Nullable TraceState traceState,
@Nullable Scope scope,
@Nullable Hint hint) {
return captureTransaction(transaction, traceState, scope, hint, null);
}
/**
* Captures a transaction.
*
* @param transaction the {@link ITransaction} to send
* @param traceState the trace state
* @param scope An optional scope to be applied to the event.
* @param hint SDK specific but provides high level information about the origin of the event
* @param profilingTraceData An optional profiling trace data captured during the transaction
* @return The Id (SentryId object) of the event
*/
@NotNull
@ApiStatus.Internal
SentryId captureTransaction(
@NotNull SentryTransaction transaction,
@Nullable TraceState traceState,
@Nullable Scope scope,
@Nullable Hint hint,
@Nullable ProfilingTraceData profilingTraceData);
/**
* Captures a transaction without scope nor hint.
*
* @param transaction the {@link ITransaction} to send
* @param traceState the trace state
* @return The Id (SentryId object) of the event
*/
@ApiStatus.Internal
default @NotNull SentryId captureTransaction(
@NotNull SentryTransaction transaction, @Nullable TraceState traceState) {
return captureTransaction(transaction, traceState, null, null);
}
/**
* Captures a transaction without scope nor hint.
*
* @param transaction the {@link ITransaction} to send
* @return The Id (SentryId object) of the event
*/
default @NotNull SentryId captureTransaction(@NotNull SentryTransaction transaction) {
return captureTransaction(transaction, null, null, null);
}
}