Skip to content

Feature/log trace context #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sgryphon wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Feature/log trace context #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
125d721
WIP - start adding support for trace context
sgryphon Oct 31, 2020
1d0e74f
Clean up some of the trace context use
sgryphon Oct 31, 2020
73a7d9a
Minor fixes
sgryphon Oct 31, 2020
174efe3
Update build script
sgryphon Oct 31, 2020
468bd05
Generated definitions
sgryphon Oct 31, 2020
8984713
Generated JS files
sgryphon Oct 31, 2020
c5fcd2c
Add NPM typescript to dependencies
sgryphon Oct 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions Definitions/DefinitionsGenerator/jsnlog.NonJlInterfaces.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@
requestId?: string;
defaultBeforeSend?: (xhr: XMLHttpRequest) => void;
serialize?: (object: any) => string;
traceContextProvider?: () => JSNLogTraceContext;
}

interface JSNLogTraceContext {
traceId: string;
spanId: string;
parentSpanId?: string;
}

interface JSNLogFilterOptions {
Expand Down Expand Up @@ -39,14 +46,14 @@
interface JSNLogLogger {
setOptions(options: JSNLogLoggerOptions): JSNLogLogger;

trace(logObject: any): JSNLogLogger;
debug(logObject: any): JSNLogLogger;
info(logObject: any): JSNLogLogger;
warn(logObject: any): JSNLogLogger;
error(logObject: any): JSNLogLogger;
fatal(logObject: any): JSNLogLogger;
fatalException(logObject: any, e: any): JSNLogLogger;
log(level: number, logObject: any, e?: any): JSNLogLogger;
trace(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
debug(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
info(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
warn(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
error(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatal(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatalException(logObject: any, e: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
log(level: number, logObject: any, e?: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
}

// setOptions and sendBatch have to be optional, so you can use a Winston transport as
Expand Down
23 changes: 15 additions & 8 deletions Definitions/jl.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ declare namespace JL {
requestId?: string;
defaultBeforeSend?: (xhr: XMLHttpRequest) => void;
serialize?: (object: any) => string;
traceContextProvider?: () => JSNLogTraceContext;
}

interface JSNLogTraceContext {
traceId: string;
spanId: string;
parentSpanId?: string;
}

interface JSNLogFilterOptions {
Expand Down Expand Up @@ -66,14 +73,14 @@ declare namespace JL {
interface JSNLogLogger {
setOptions(options: JSNLogLoggerOptions): JSNLogLogger;

trace(logObject: any): JSNLogLogger;
debug(logObject: any): JSNLogLogger;
info(logObject: any): JSNLogLogger;
warn(logObject: any): JSNLogLogger;
error(logObject: any): JSNLogLogger;
fatal(logObject: any): JSNLogLogger;
fatalException(logObject: any, e: any): JSNLogLogger;
log(level: number, logObject: any, e?: any): JSNLogLogger;
trace(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
debug(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
info(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
warn(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
error(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatal(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatalException(logObject: any, e: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
log(level: number, logObject: any, e?: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
}

// setOptions and sendBatch have to be optional, so you can use a Winston transport as
Expand Down
2 changes: 1 addition & 1 deletion Definitions/jsnlog-tests.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 15 additions & 8 deletions Definitions/jsnlog.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ declare namespace JL {
requestId?: string;
defaultBeforeSend?: (xhr: XMLHttpRequest) => void;
serialize?: (object: any) => string;
traceContextProvider?: () => JSNLogTraceContext;
}

interface JSNLogTraceContext {
traceId: string;
spanId: string;
parentSpanId?: string;
}

interface JSNLogFilterOptions {
Expand Down Expand Up @@ -66,14 +73,14 @@ declare namespace JL {
interface JSNLogLogger {
setOptions(options: JSNLogLoggerOptions): JSNLogLogger;

trace(logObject: any): JSNLogLogger;
debug(logObject: any): JSNLogLogger;
info(logObject: any): JSNLogLogger;
warn(logObject: any): JSNLogLogger;
error(logObject: any): JSNLogLogger;
fatal(logObject: any): JSNLogLogger;
fatalException(logObject: any, e: any): JSNLogLogger;
log(level: number, logObject: any, e?: any): JSNLogLogger;
trace(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
debug(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
info(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
warn(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
error(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatal(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatalException(logObject: any, e: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
log(level: number, logObject: any, e?: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
}

// setOptions and sendBatch have to be optional, so you can use a Winston transport as
Expand Down
23 changes: 15 additions & 8 deletions Definitions/jsnlog_interfaces.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ declare namespace JL {
requestId?: string;
defaultBeforeSend?: (xhr: XMLHttpRequest) => void;
serialize?: (object: any) => string;
traceContextProvider?: () => JSNLogTraceContext;
}

interface JSNLogTraceContext {
traceId: string;
spanId: string;
parentSpanId?: string;
}

interface JSNLogFilterOptions {
Expand Down Expand Up @@ -69,14 +76,14 @@ declare namespace JL {
interface JSNLogLogger {
setOptions(options: JSNLogLoggerOptions): JSNLogLogger;

trace(logObject: any): JSNLogLogger;
debug(logObject: any): JSNLogLogger;
info(logObject: any): JSNLogLogger;
warn(logObject: any): JSNLogLogger;
error(logObject: any): JSNLogLogger;
fatal(logObject: any): JSNLogLogger;
fatalException(logObject: any, e: any): JSNLogLogger;
log(level: number, logObject: any, e?: any): JSNLogLogger;
trace(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
debug(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
info(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
warn(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
error(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatal(logObject: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
fatalException(logObject: any, e: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
log(level: number, logObject: any, e?: any, traceContext?: JSNLogTraceContext): JSNLogLogger;
}

// setOptions and sendBatch have to be optional, so you can use a Winston transport as
Expand Down
63 changes: 46 additions & 17 deletions jsnlog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
* Copyright 2012-2017 Mattijs Perdeck All rights reserved.
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
Expand Down Expand Up @@ -262,6 +265,7 @@ function JL(loggerName) {
copyProperty("requestId", options, this);
copyProperty("defaultBeforeSend", options, this);
copyProperty("serialize", options, this);
copyProperty("traceContextProvider", options, this);
return this;
}
JL.setOptions = setOptions;
Expand Down Expand Up @@ -328,22 +332,41 @@ function JL(loggerName) {
// n: logger name
// t (timeStamp) is number of milliseconds since 1 January 1970 00:00:00 UTC
// u: number uniquely identifying this entry for this request.
// c: trace context, if provided
//
// Keeping the property names really short, because they will be sent in the
// JSON payload to the server.
function LogItem(l, m, n, t, u) {
function LogItem(l, m, n, t, u, c) {
this.l = l;
this.m = m;
this.n = n;
this.t = t;
this.u = u;
this.c = c;
}
return LogItem;
}());
JL.LogItem = LogItem;
function newLogItem(levelNbr, message, loggerName) {
var LogTraceContext = /** @class */ (function () {
// d: distributed trace-id for W3C trace context
// s: span-id of the span for this particular log message
// p: parent span-id, if this span has a parent span
//
// Keeping the property names really short, because they will be sent in the
// JSON payload to the server.
function LogTraceContext(d, s, p) {
this.d = d;
this.s = s;
this.p = p;
}
return LogTraceContext;
}());
JL.LogTraceContext = LogTraceContext;
function newLogItem(levelNbr, message, loggerName, traceContext) {
JL.entryId++;
return new LogItem(levelNbr, message, loggerName, JL._getTime(), JL.entryId);
var c = traceContext === undefined ? undefined
: new LogTraceContext(traceContext.traceId, traceContext.spanId, traceContext.parentSpanId);
return new LogItem(levelNbr, message, loggerName, JL._getTime(), JL.entryId, c);
}
function clearTimer(timer) {
if (timer.id) {
Expand Down Expand Up @@ -535,7 +558,7 @@ function JL(loggerName) {
message - log item. If the user logged an object, this is the JSON string. Not used by Winston transports.
loggerName: name of the logger. Not used by Winston transports.
*/
Appender.prototype.log = function (level, msg, meta, callback, levelNbr, message, loggerName) {
Appender.prototype.log = function (level, msg, meta, callback, levelNbr, message, loggerName, traceContext) {
var logItem;
if (!allow(this)) {
return;
Expand All @@ -547,7 +570,7 @@ function JL(loggerName) {
// Ignore the log item completely
return;
}
logItem = newLogItem(levelNbr, message, loggerName);
logItem = newLogItem(levelNbr, message, loggerName, traceContext);
if (levelNbr < this.level) {
// Store in the hold buffer. Do not send.
if (this.bufferSize > 0) {
Expand Down Expand Up @@ -864,7 +887,7 @@ function JL(loggerName) {
// The resulting exception object is than worked into a message to the server.
//
// If there is no exception, logObject itself is worked into the message to the server.
Logger.prototype.log = function (level, logObject, e) {
Logger.prototype.log = function (level, logObject, e, traceContext) {
var i = 0;
var compositeMessage;
var excObject;
Expand Down Expand Up @@ -895,6 +918,12 @@ function JL(loggerName) {
i--;
}
}
if (typeof JL.traceContextProvider === 'function') {
var providerTraceContext = JL.traceContextProvider();
if (providerTraceContext !== undefined) {
traceContext = providerTraceContext;
}
}
// Pass message to all appenders
// Note that these appenders could be Winston transports
// https://github.com/flatiron/winston
Expand All @@ -903,20 +932,20 @@ function JL(loggerName) {
// Do not add fields to compositeMessage.meta, otherwise the user's object will get that field out of the blue.
i = this.appenders.length - 1;
while (i >= 0) {
this.appenders[i].log(levelToString(level), compositeMessage.msg, compositeMessage.meta, function () { }, level, compositeMessage.finalString, this.loggerName);
this.appenders[i].log(levelToString(level), compositeMessage.msg, compositeMessage.meta, function () { }, level, compositeMessage.finalString, this.loggerName, traceContext);
i--;
}
}
}
return this;
};
Logger.prototype.trace = function (logObject) { return this.log(getTraceLevel(), logObject); };
Logger.prototype.debug = function (logObject) { return this.log(getDebugLevel(), logObject); };
Logger.prototype.info = function (logObject) { return this.log(getInfoLevel(), logObject); };
Logger.prototype.warn = function (logObject) { return this.log(getWarnLevel(), logObject); };
Logger.prototype.error = function (logObject) { return this.log(getErrorLevel(), logObject); };
Logger.prototype.fatal = function (logObject) { return this.log(getFatalLevel(), logObject); };
Logger.prototype.fatalException = function (logObject, e) { return this.log(getFatalLevel(), logObject, e); };
Logger.prototype.trace = function (logObject, traceContext) { return this.log(getTraceLevel(), logObject, undefined, traceContext); };
Logger.prototype.debug = function (logObject, traceContext) { return this.log(getDebugLevel(), logObject, undefined, traceContext); };
Logger.prototype.info = function (logObject, traceContext) { return this.log(getInfoLevel(), logObject, undefined, traceContext); };
Logger.prototype.warn = function (logObject, traceContext) { return this.log(getWarnLevel(), logObject, undefined, traceContext); };
Logger.prototype.error = function (logObject, traceContext) { return this.log(getErrorLevel(), logObject, undefined, traceContext); };
Logger.prototype.fatal = function (logObject, traceContext) { return this.log(getFatalLevel(), logObject, undefined, traceContext); };
Logger.prototype.fatalException = function (logObject, e, traceContext) { return this.log(getFatalLevel(), logObject, e, traceContext); };
return Logger;
}());
JL.Logger = Logger;
Expand Down
8 changes: 4 additions & 4 deletions jsnlog.js.map
View file
Open in desktop

Large diffs are not rendered by default.

Loading