bigbluebutton-Github/bigbluebutton-html5/imports/startup/client/logger.js

127 lines
3.5 KiB
JavaScript
Executable File

import Auth from '/imports/ui/services/auth';
import { Meteor } from 'meteor/meteor';
import { createLogger, stdSerializers } from 'browser-bunyan';
import { ConsoleFormattedStream } from '@browser-bunyan/console-formatted-stream';
import { ConsoleRawStream } from '@browser-bunyan/console-raw-stream';
import { ServerStream } from '@browser-bunyan/server-stream';
import { nameFromLevel } from '@browser-bunyan/levels';
// The logger accepts "console","server", and "external" as targets
// Multiple targets can be set as an array in the settings under public.log
// To add more targets use the format { "target": "server", "level": "info" },
// and add it to the public.log array
// The accepted levels are "debug", "info", "warn", "error"
// To send to URL, use the format {"target": "external","level": "info",
// "url": "","method": ""}
// externalURL is the end-point that logs will be sent to
// Call the logger by doing a function call with the level name, I.e, logger.warn('Hi on warn')
const LOG_CONFIG = Meteor.settings.public.clientLog || { console: { enabled: true, level: 'info' } };
// Custom stream that logs to an end-point
class ServerLoggerStream extends ServerStream {
constructor(params) {
super(params);
if (params.logTag) {
this.logTagString = params.logTag;
}
}
write(rec) {
const { fullInfo } = Auth;
this.rec = rec;
if (fullInfo.meetingId != null) {
this.rec.userInfo = fullInfo;
}
this.rec.clientBuild = Meteor.settings.public.app.html5ClientBuild;
this.rec.connectionId = Meteor.connection._lastSessionId;
if (this.logTagString) {
this.rec.logTag = this.logTagString;
}
return super.write(this.rec);
}
}
// Custom stream to log to the meteor server
class MeteorStream {
write(rec) {
const { fullInfo } = Auth;
const clientURL = window.location.href;
this.rec = rec;
if (fullInfo.meetingId != null) {
if (!this.rec.extraInfo) {
this.rec.extraInfo = {};
}
this.rec.extraInfo.clientURL = clientURL;
Meteor.call(
'logClient',
nameFromLevel[this.rec.level],
this.rec.msg,
this.rec.logCode,
this.rec.extraInfo,
fullInfo,
);
} else {
Meteor.call(
'logClient',
nameFromLevel[this.rec.level],
this.rec.msg,
this.rec.logCode,
{ ...rec.extraInfo, clientURL },
);
}
}
}
function createStreamForTarget(target, options) {
const TARGET_EXTERNAL = 'external';
const TARGET_CONSOLE = 'console';
const TARGET_SERVER = 'server';
let Stream = ConsoleRawStream;
switch (target) {
case TARGET_EXTERNAL:
Stream = ServerLoggerStream;
break;
case TARGET_CONSOLE:
Stream = ConsoleFormattedStream;
break;
case TARGET_SERVER:
Stream = MeteorStream;
break;
default:
Stream = ConsoleFormattedStream;
}
return new Stream(options);
}
function generateLoggerStreams(config) {
let result = [];
Object.keys(config).forEach((key) => {
const logOption = config[key];
if (logOption && logOption.enabled) {
const { level, ...streamOptions } = logOption;
result = result.concat({ level, stream: createStreamForTarget(key, streamOptions) });
}
});
return result;
}
// Creates the logger with the array of streams of the chosen targets
const logger = createLogger({
name: 'clientLogger',
streams: generateLoggerStreams(LOG_CONFIG),
serializers: stdSerializers,
src: true,
});
export default logger;