Skip to content

fix: Prepend formatted timestamps to unstructured log events (fixes #201). #209

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

Merged
merged 8 commits into from
Mar 11, 2025
Merged

fix: Prepend formatted timestamps to unstructured log events (fixes #201). #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c31582a
fix: Format unstructured log events by prepending timestamps.
junhaoliao Mar 10, 2025
85cf316
Update date regex to include timezone offset in the new format.
junhaoliao Mar 10, 2025
679e4a5
improve docs.
junhaoliao Mar 10, 2025
51088ef
Docs - Apply suggestions from code review
junhaoliao Mar 10, 2025
de3f3e6
fix: Rename parameter in formatUnstructuredResults for clarity.
junhaoliao Mar 10, 2025
de72a6d
Update decodeRange method to throw an error when formatter is not set…
junhaoliao Mar 10, 2025
46e2a5e
Update monaco custom date pattern string - Apply suggestions from cod…
junhaoliao Mar 10, 2025
97bb6ac
Correct regex for custom date pattern to handle decimal separator con…
junhaoliao Mar 10, 2025
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
2 changes: 1 addition & 1 deletion src/components/Editor/MonacoInstance/language.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const setupCustomLogLanguage = () => {
TOKEN_NAME.CUSTOM_FATAL,
],
[
/(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3})Z?/,
/\d{4}-\d{2}-\d{2}(?:[T ]\d{2}:\d{2}:\d{2}(?:[.,]\d+)?(?:[+-]\d{2}:?\d{2}|Z)?)?/,
TOKEN_NAME.CUSTOM_DATE,
],
[
Expand Down
32 changes: 30 additions & 2 deletions src/services/decoders/ClpIrDecoder/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,25 @@ class ClpIrDecoder implements Decoder {
return new ClpIrDecoder(module, dataArray, decoderOptions);
}

/**
* Formats unstructured log events by prepending a formatted timestamp to each message.
*
* @param logEvents
* @return The formatted log events.
*/
static #formatUnstructuredResults = (logEvents: DecodeResult[]): DecodeResult[] => {
for (const r of logEvents) {
const [
message, timestamp,
] = r;

const dayJsTimestamp: Dayjs = convertToDayjsTimestamp(timestamp);
r[0] = dayJsTimestamp.format("YYYY-MM-DDTHH:mm:ss.SSSZ") + message;
}

return logEvents;
};

getEstimatedNumEvents (): number {
return this.#streamReader.getNumEventsBuffered();
}
Expand Down Expand Up @@ -109,6 +128,15 @@ class ClpIrDecoder implements Decoder {
return true;
}

/**
* See {@link Decoder.decodeRange}.
*
* @param beginIdx
* @param endIdx
* @param useFilter
* @return
* @throws {Error} if the formatter is not set for structured logs.
*/
decodeRange (
beginIdx: number,
endIdx: number,
Expand All @@ -127,10 +155,10 @@ class ClpIrDecoder implements Decoder {
if (this.#streamType === CLP_IR_STREAM_TYPE.STRUCTURED) {
// eslint-disable-next-line no-warning-comments
// TODO: Revisit when we allow displaying structured logs without a formatter.
console.error("Formatter is not set for structured logs.");
throw new Error("Formatter is not set for structured logs.");
}

return results;
return ClpIrDecoder.#formatUnstructuredResults(results);
}

for (const r of results) {
Expand Down