This repository has been archived by the owner on Dec 27, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 44
[DNM] Add logOperationTime util with implementation in protocol module #398
Draft
jakekidd
wants to merge
2
commits into
main
Choose a base branch
from
log-operation-time
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
import pino from "pino"; | ||
import { performance } from 'perf_hooks'; | ||
|
||
/// This method is used to log the start and end time of an executed method. We are using the | ||
/// perf_hooks (performance) lib provided by node to calculate this - much more accurate than | ||
/// Date.now(). On first call, a unique label string is generated and returned. On second call, | ||
/// same label string should be passed in to measure and log the diff in time (i.e. amount of | ||
/// time method took to execute in ms). | ||
export const logOperationTime = (log: pino.BaseLogger, method: string, methodId: string, startMark?: string): string => { | ||
const mark = `${method}-${methodId}` | ||
if (startMark) { | ||
const stopMark = `${mark}-stop`; | ||
const timestamp = performance.mark(stopMark); | ||
performance.measure(mark, startMark, stopMark); | ||
const diff = performance.getEntries({name : mark, entryType: "measure"}); | ||
|
||
// Depending on how long method took, up severity of logging call. This is a default | ||
// arrangement that was copied over from indra. | ||
const message = `${method} : finished; took ${diff} ms`; | ||
if (diff < 2) { | ||
log.debug(message); | ||
} else if (diff < 200) { | ||
log.info(message); | ||
} else { | ||
log.warn(message); | ||
} | ||
} else { | ||
// Generate the label we'll be using (for later ref) using unique hexstring. | ||
const startMark = `${mark}-start`; | ||
performance.mark(startMark); | ||
// Debug log notify method started. | ||
const message = `${method}: started`; | ||
log.debug(message); | ||
} | ||
// We return the startMark so it can be passed back in for later method call. | ||
return startMark; | ||
}; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We will likely want to keep the
methodId
to log throughout the other parts of the method so the logs are easily searchable. Maybe we should use thelabel
as themethodId
instead.General purpose of the
methodId
is to get a unique strings so that you can easily identify all logs that came from a given method when searching in log dna or whatever other log parserThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. This functionality is already internal to the
logOperationTime
method. I actually had it like that at first, but worried that not all methods would follow this standard of generating a methodId. Will add this back tho, thanks