Matrix/element-call-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-call.git synced 2024-11-21 00:28:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Rageshake logging improvements (#2622)

Browse Source
This commit is contained in:
Hugh Nimmo-Smith 2024-09-11 14:02:59 +01:00 committed by GitHub
parent 460aa7618a
commit 7e5b70d439
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main.tsx
View File

@ -18,7 +18,7 @@ import "./index.css";
import { logger } from "matrix-js-sdk/src/logger"; import { logger } from "matrix-js-sdk/src/logger";
import { import {
setLogExtension as setLKLogExtension, setLogExtension as setLKLogExtension,
setLogLevel, setLogLevel as setLKLogLevel,
} from "livekit-client"; } from "livekit-client";
import { App } from "./App"; import { App } from "./App";
@ -28,9 +28,11 @@ import { Initializer } from "./initializer";
initRageshake().catch((e) => { initRageshake().catch((e) => {
logger.error("Failed to initialize rageshake", e); logger.error("Failed to initialize rageshake", e);
}); });
setLKLogLevel("debug");
setLogLevel("debug"); setLKLogExtension((level, msg, context) => {
setLKLogExtension(global.mx_rage_logger.log); // we pass a synthetic logger name of "livekit" to the rageshake to make it easier to read
global.mx_rage_logger.log(level, "livekit", msg, context);
});
logger.info(`Element Call ${import.meta.env.VITE_APP_VERSION || "dev"}`); logger.info(`Element Call ${import.meta.env.VITE_APP_VERSION || "dev"}`);

28
src/settings/rageshake.ts
View File

@ -29,9 +29,9 @@ Please see LICENSE in the repository root for full details.
import EventEmitter from "events"; import EventEmitter from "events";
import { throttle } from "lodash"; import { throttle } from "lodash";
import { logger } from "matrix-js-sdk/src/logger"; import { Logger, logger } from "matrix-js-sdk/src/logger";
import { randomString } from "matrix-js-sdk/src/randomstring"; import { randomString } from "matrix-js-sdk/src/randomstring";
import { LoggingMethod } from "loglevel"; import loglevel, { LoggingMethod } from "loglevel";
// the length of log data we keep in indexeddb (and include in the reports) // the length of log data we keep in indexeddb (and include in the reports)
const MAX_LOG_SIZE = 1024 * 1024 * 5; // 5 MB const MAX_LOG_SIZE = 1024 * 1024 * 5; // 5 MB
@ -467,7 +467,12 @@ declare global {
*/ */
export async function init(): Promise<void> { export async function init(): Promise<void> {
global.mx_rage_logger = new ConsoleLogger(); global.mx_rage_logger = new ConsoleLogger();
setLogExtension(global.mx_rage_logger.log); setLogExtension(logger, global.mx_rage_logger.log);
// these are the child/prefixed loggers we want to capture from js-sdk
// there doesn't seem to be an easy way to capture all children
["MatrixRTCSession", "MatrixRTCSessionManager"].forEach((loggerName) => {
setLogExtension(logger.getChild(loggerName), global.mx_rage_logger.log);
});
return tryInitStorage(); return tryInitStorage();
} }
@ -580,10 +585,14 @@ type LogLevelString = keyof typeof LogLevel;
* took loglevel's example honouring log levels). Adds a loglevel logging extension * took loglevel's example honouring log levels). Adds a loglevel logging extension
* in the recommended way. * in the recommended way.
*/ */
export function setLogExtension(extension: LogExtensionFunc): void { function setLogExtension(
const originalFactory = logger.methodFactory; _loggerToExtend: Logger,
extension: LogExtensionFunc,
): void {
const loggerToExtend = _loggerToExtend as unknown as loglevel.Logger;
const originalFactory = loggerToExtend.methodFactory;
logger.methodFactory = function ( loggerToExtend.methodFactory = function (
methodName, methodName,
configLevel, configLevel,
loggerName, loggerName,
@ -594,11 +603,14 @@ export function setLogExtension(extension: LogExtensionFunc): void {
const needLog = logLevel >= configLevel && logLevel < LogLevel.silent; const needLog = logLevel >= configLevel && logLevel < LogLevel.silent;
return (...args) => { return (...args) => {
// we don't send the logger name to the raw method as some of them are already outputting the prefix
rawMethod.apply(this, args); rawMethod.apply(this, args);
if (needLog) { if (needLog) {
extension(logLevel, ...args); // we prefix the logger name to the extension
// this makes sure that the rageshake contains the logger name
extension(logLevel, loggerName?.toString(), ...args);
} }
}; };
}; };
logger.setLevel(logger.getLevel()); // Be sure to call setLevel method in order to apply plugin loggerToExtend.setLevel(loggerToExtend.getLevel()); // Be sure to call setLevel method in order to apply plugin
} }