-
Notifications
You must be signed in to change notification settings - Fork 989
/
CallStatsIOTransport.java
416 lines (374 loc) · 13.7 KB
/
CallStatsIOTransport.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
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jitsi.videobridge.stats;
import io.callstats.sdk.*;
import io.callstats.sdk.data.*;
import io.callstats.sdk.listeners.*;
import net.java.sip.communicator.util.*;
import net.java.sip.communicator.util.Logger;
import org.jitsi.service.configuration.*;
import org.jitsi.service.version.*;
import org.jitsi.util.*;
import org.jitsi.videobridge.stats.callstats.*;
import org.osgi.framework.*;
/**
* Implements {@code StatsTransport} for
* <a href="http://www.callstats.io">callstats.io</a>.
*
* @author Lyubomir Marinov
*/
public class CallStatsIOTransport
extends StatsTransport
{
/**
* The {@code Logger} used by the {@code CallStatsIOTransport} class and its
* instances to print debug information.
*/
private static final Logger logger
= Logger.getLogger(CallStatsIOTransport.class);
/**
* The callstats AppID.
*/
private static final String PNAME_CALLSTATS_IO_APP_ID
= "io.callstats.sdk.CallStats.appId";
/**
* Shared Secret for authentication on Callstats.io
*/
private static final String PNAME_CALLSTATS_IO_APP_SECRET
= "io.callstats.sdk.CallStats.appSecret";
/**
* ID of the key that was used to generate token.
*/
private static final String PNAME_CALLSTATS_IO_KEY_ID
= "io.callstats.sdk.CallStats.keyId";
/**
* The path to private key file.
*/
private static final String PNAME_CALLSTATS_IO_KEY_PATH
= "io.callstats.sdk.CallStats.keyPath";
/**
* The bridge id to report to callstats.io.
*/
public static final String PNAME_CALLSTATS_IO_BRIDGE_ID
= "io.callstats.sdk.CallStats.bridgeId";
/**
* The default bridge id to use if setting is missing.
*/
public static final String DEFAULT_BRIDGE_ID = "jitsi";
/**
* The bridge conference prefix to report to callstats.io.
*/
public static final String PNAME_CALLSTATS_IO_CONF_PREFIX
= "io.callstats.sdk.CallStats.conferenceIDPrefix";
/**
* The {@code BridgeStatusInfoBuilder} which initializes new
* {@code BridgeStatusInfo} instances (to be sent by {@code CallStats}).
* Since reentrancy and thread-safety related issues are taken care of by
* the invoker of {@link #publishStatistics(Statistics)}, the instance is
* cached for the sake of performance.
*/
private BridgeStatusInfoBuilder bridgeStatusInfoBuilder;
/**
* The entry point into the callstats.io (Java) library.
*/
private CallStats callStats;
/**
* CallStats service registration.
*/
private ServiceRegistration<CallStats> serviceRegistration;
/**
* {@inheritDoc}
*/
@Override
protected void bundleContextChanged(
BundleContext oldValue,
BundleContext newValue)
{
super.bundleContextChanged(oldValue, newValue);
if (newValue == null)
dispose(oldValue);
else if (oldValue == null)
init(newValue);
}
/**
* Notifies this {@code CallStatsIOTransport} that a specific
* {@code CallStats} failed to initialize.
*
* @param callStats the {@code CallStats} which failed to initialize
* @param error the error
* @param errMsg the error message
*/
private void callStatsOnError(
CallStats callStats,
CallStatsErrors error,
String errMsg)
{
logger.error(
"callstats.io Java library failed to initialize with error: "
+ error + " and error message: " + errMsg);
}
/**
* Notifies this {@code CallStatsIOTransport} that a specific
* {@code CallStats} initialized.
*
* @param callStats the {@code CallStats} which initialized
* @param msg the message sent by {@code callStats} upon the successful
* initialization
*/
private void callStatsOnInitialized(CallStats callStats, String msg)
{
// callstats get re-initialized every few hours, which
// can leads to registering callstats in osgi many times, while
// the service instance is the same
if(serviceRegistration != null)
return;
bridgeStatusInfoBuilder = new BridgeStatusInfoBuilder();
if (logger.isDebugEnabled())
{
logger.debug(
"callstats.io Java library initialized successfully"
+ " with message: " + msg);
}
serviceRegistration
= getBundleContext().registerService(
CallStats.class,
callStats,
null);
}
/**
* Initializes a new {@code ServerInfo} instance.
*
* @param bundleContext the {@code BundleContext} in which the method is
* invoked
* @return a new {@code ServerInfo} instance
*/
private ServerInfo createServerInfo(BundleContext bundleContext)
{
ServerInfo serverInfo = new ServerInfo();
// os
serverInfo.setOs(System.getProperty("os.name"));
// name & ver
VersionService versionService
= ServiceUtils.getService(bundleContext, VersionService.class);
if (versionService != null)
{
org.jitsi.service.version.Version version
= versionService.getCurrentVersion();
// name
serverInfo.setName(version.getApplicationName());
// ver
serverInfo.setVer(version.toString());
}
return serverInfo;
}
/**
* Disposes of this {@code StatsTransport} so that
* {@link #publishStatistics(Statistics)} may not execute successfully any
* longer.
*
* @param bundleContext the {@code BundleContext} in which this
* {@code StatsTransport} is to be disposed
*/
private void dispose(BundleContext bundleContext)
{
if (serviceRegistration != null)
{
serviceRegistration.unregister();
serviceRegistration = null;
}
bridgeStatusInfoBuilder = null;
callStats = null;
}
/**
* Initializes this {@code StatsTransport} so that
* {@link #publishStatistics(Statistics)} may executed successfully.
* Initializes {@link #callStats} i.e. the callstats.io (Java) library.
*
* @param bundleContext the {@code BundleContext} in which this
* {@code StatsTransport} is to be initialized
*/
private void init(BundleContext bundleContext)
{
ConfigurationService cfg
= ServiceUtils.getService(
bundleContext,
ConfigurationService.class);
init(bundleContext, cfg);
}
/**
* Initializes this {@code StatsTransport} so that
* {@link #publishStatistics(Statistics)} may executed successfully.
* Initializes {@link #callStats} i.e. the callstats.io (Java) library.
*
* @param bundleContext the {@code BundleContext} in which this
* {@code StatsTransport} is to be initialized
* @param cfg the {@code ConfigurationService} registered in
* {@code bundleContext} if any
*/
private void init(BundleContext bundleContext, ConfigurationService cfg)
{
int appId = ConfigUtils.getInt(cfg, PNAME_CALLSTATS_IO_APP_ID, 0);
String appSecret
= ConfigUtils.getString(cfg, PNAME_CALLSTATS_IO_APP_SECRET, null);
String keyId
= ConfigUtils.getString(cfg, PNAME_CALLSTATS_IO_KEY_ID, null);
String keyPath
= ConfigUtils.getString(cfg, PNAME_CALLSTATS_IO_KEY_PATH, null);
String bridgeId = ConfigUtils.getString(
cfg, PNAME_CALLSTATS_IO_BRIDGE_ID, DEFAULT_BRIDGE_ID);
/**
* prefer keyId/keyPath over appSecret
*/
if(keyId == null || keyPath == null)
{
logger.warn("KeyID/keyPath missing, will try using appSecret");
if(appSecret == null)
{
logger.warn("appSecret missing. Skipping callstats init");
return;
}
}
ServerInfo serverInfo = createServerInfo(bundleContext);
final CallStats callStats = new CallStats();
// The method CallStats.initialize() will (likely) return asynchronously
// so it may be better to make the new CallStats instance available to
// the rest of CallStatsIOTransport before the method in question
// returns even if it may fail.
this.callStats = callStats;
CallStatsInitListener callStatsInitListener =
new CallStatsInitListener()
{
/**
* {@inheritDoc}
*/
@Override
public void onError(CallStatsErrors error, String errMsg)
{
callStatsOnError(callStats, error, errMsg);
}
/**
* {@inheritDoc}
*/
@Override
public void onInitialized(String msg)
{
callStatsOnInitialized(callStats, msg);
}
};
if(keyId != null && keyPath != null)
{
callStats.initialize(
appId,
new TokenGenerator(
String.valueOf(appId), keyId, bridgeId, keyPath),
bridgeId,
serverInfo,
callStatsInitListener);
}
else
{
callStats.initialize(
appId,
appSecret,
bridgeId,
serverInfo,
callStatsInitListener);
}
}
/**
* Reads data from {@code statistics} and writes it into
* {@code bridgeStatusInfoBuilder}.
*
* @param bsib the {@code BridgeStatusInfoBuilder} into which data read from
* {@code statistics} is to be written
* @param s the {@code Statistics} from which data is to be read and written
* into {@code bridgeStatusInfoBuilder}
* @param measurementInterval the interval of time in milliseconds covered
* by the measurements carried by the specified {@code statistics}
*/
private void populateBridgeStatusInfoBuilderWithStatistics(
BridgeStatusInfoBuilder bsib,
Statistics s,
long measurementInterval)
{
bsib.audioFabricCount(
s.getStatAsInt(VideobridgeStatistics.AUDIOCHANNELS));
bsib.avgIntervalJitter(
s.getStatAsInt(VideobridgeStatistics.JITTER_AGGREGATE));
bsib.avgIntervalRtt(
s.getStatAsInt(VideobridgeStatistics.RTT_AGGREGATE));
bsib.conferenceCount(s.getStatAsInt(VideobridgeStatistics.CONFERENCES));
bsib.cpuUsage(
(float) s.getStatAsDouble(VideobridgeStatistics.CPU_USAGE));
bsib.intervalDownloadBitRate(
(int)
Math.round(
s.getStatAsDouble(
VideobridgeStatistics.BITRATE_DOWNLOAD)));
// TODO intervalReceivedBytes
// uses download loss rate, as the upload is not properly measured
// currently and vary a lot, which also breaks RTP_LOSS value.
bsib.intervalRtpFractionLoss(
(float)s.getStatAsDouble(VideobridgeStatistics.LOSS_RATE_DOWNLOAD));
// TODO intervalSentBytes
bsib.intervalUploadBitRate(
(int)
Math.round(
s.getStatAsDouble(
VideobridgeStatistics.BITRATE_UPLOAD)));
bsib.measurementInterval((int) measurementInterval);
bsib.memoryUsage(s.getStatAsInt(VideobridgeStatistics.USED_MEMORY));
bsib.participantsCount(
s.getStatAsInt(VideobridgeStatistics.NUMBEROFPARTICIPANTS));
bsib.threadCount(s.getStatAsInt(VideobridgeStatistics.NUMBEROFTHREADS));
// TODO totalLoss
bsib.totalMemory(s.getStatAsInt(VideobridgeStatistics.TOTAL_MEMORY));
bsib.videoFabricCount(
s.getStatAsInt(VideobridgeStatistics.VIDEOCHANNELS));
}
/**
* {@inheritDoc}
*
* {@code CallStatsIOTransport} overrides
* {@link #publishStatistics(Statistics, long)} so it does not have to do
* anything in its implementation of {@link #publishStatistics(Statistics)}.
*/
@Override
public void publishStatistics(Statistics statistics)
{
}
/**
* {@inheritDoc}
*/
@Override
public void publishStatistics(
Statistics statistics,
long measurementInterval)
{
// Queuing is not implemented by CallStats at the time of this writing.
if (callStats != null && callStats.isInitialized())
{
BridgeStatusInfoBuilder bridgeStatusInfoBuilder
= this.bridgeStatusInfoBuilder;
populateBridgeStatusInfoBuilderWithStatistics(
bridgeStatusInfoBuilder,
statistics,
measurementInterval);
callStats.sendCallStatsBridgeStatusUpdate(
bridgeStatusInfoBuilder.build());
}
}
}