-
Notifications
You must be signed in to change notification settings - Fork 215
/
ConnectionLogger.java
176 lines (155 loc) · 6.39 KB
/
ConnectionLogger.java
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
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.connectivity.service.messaging.monitoring.logs;
import java.io.Closeable;
import java.util.Collection;
import javax.annotation.Nullable;
import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.connectivity.model.ConnectionId;
import org.eclipse.ditto.connectivity.model.LogEntry;
import org.eclipse.ditto.connectivity.service.config.MonitoringLoggerConfig;
import org.eclipse.ditto.connectivity.service.messaging.monitoring.ConnectionMonitor;
/**
* Logger for connections that provides log messages for end users.
*/
public interface ConnectionLogger extends Closeable {
/**
* Gets the connection logger for the given connection ID.
*
* @param connectionId the ID of the connection.
* @param config the logger config.
* @return the logger.
*/
static ConnectionLogger getInstance(final ConnectionId connectionId, final MonitoringLoggerConfig config) {
final ConnectionLoggerRegistry connectionLoggerRegistry = ConnectionLoggerRegistry.fromConfig(config);
return connectionLoggerRegistry.forConnection(connectionId);
}
/**
* Get all log entries stored in this logger.
*
* @return the log entries.
*/
Collection<LogEntry> getLogs();
/**
* Log a success event.
*
* @param infoProvider containing additional information on the event.
*/
void success(ConnectionMonitor.InfoProvider infoProvider);
/**
* Log a success event.
*
* @param infoProvider containing additional information on the event.
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
* {@link java.text.MessageFormat#format(String, Object...)} is used for applying message arguments to {@code message}.
*/
void success(ConnectionMonitor.InfoProvider infoProvider, String message, Object... messageArguments);
/**
* Log a failure event.
*
* @param infoProvider containing additional information on the event.
* @param exception the exception that caused a failure. Its message is used in the log entry.
*/
void failure(ConnectionMonitor.InfoProvider infoProvider, @Nullable DittoRuntimeException exception);
/**
* Log a failure event.
*
* @param infoProvider containing additional information on the event.
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
* {@link java.text.MessageFormat#format(String, Object...)} is used for applying message arguments to {@code message}.
*/
void failure(ConnectionMonitor.InfoProvider infoProvider, String message, Object... messageArguments);
/**
* Log a failure event.
*
* @param infoProvider containing additional information on the event.
* @param exception the exception that caused a failure. Its message is used in the log entry.
*/
void exception(ConnectionMonitor.InfoProvider infoProvider, @Nullable Throwable exception);
/**
* Log an exception event.
*
* @param infoProvider containing additional information on the event.
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
* {@link java.text.MessageFormat#format(String, Object...)} is used for applying message arguments to {@code message}.
*/
void exception(ConnectionMonitor.InfoProvider infoProvider, String message, Object... messageArguments);
/**
* Clears the logs.
*/
void clear();
/**
* Log a success event.
*
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
*/
default void success(final String message, final Object... messageArguments) {
success(InfoProviderFactory.empty(), message, messageArguments);
}
/**
* Log a failure event.
*
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
*/
default void failure(final String message, final Object... messageArguments) {
failure(InfoProviderFactory.empty(), message, messageArguments);
}
/**
* Log a failure event.
*
* @param infoProvider containing additional information on the event.
*/
default void failure(final ConnectionMonitor.InfoProvider infoProvider) {
failure(infoProvider, null);
}
/**
* Log a failure event.
*
* @param signal containing additional information on the event.
* @param exception the exception that caused a failure. Its message is used in the log entry.
*/
default void failure(final Signal<?> signal, @Nullable final DittoRuntimeException exception) {
failure(InfoProviderFactory.forSignal(signal), exception);
}
/**
* Log an exception event.
*
* @param message a custom message that is used for logging the event.
* @param messageArguments additional message arguments that are part of {@code message}.
*/
default void exception(final String message, final Object... messageArguments) {
exception(InfoProviderFactory.empty(), message, messageArguments);
}
/**
* Log an exception event.
*
* @param infoProvider containing additional information on the event.
*/
default void exception(final ConnectionMonitor.InfoProvider infoProvider) {
exception(infoProvider, null);
}
/**
* Logs the specified {@code LogEntry} argument.
*
* @param logEntry the entry to be logged.
* @throws NullPointerException if {@code logEntry} is {@code null}.
* @since 2.3.0
*/
void logEntry(LogEntry logEntry);
}