Improve heartbeat log #108
Merged
Conversation
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
Siegrift
commented
Nov 4, 2023
|
|
||
| export const signHeartbeat = async (airnodeWallet: ethers.Wallet, heartbeatPayload: unknown[]) => { | ||
| // We need to make sure the object is stringified in the same way every time, so we sort the keys alphabetically. |
There was a problem hiding this comment.
Note, winston logger sort the context keys alphabetically when formatting the log message. However, objects are unordered so we should not assume any convention and sort these explicitly.
andreogle
approved these changes
Nov 5, 2023
bdrhn9
approved these changes
Nov 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #107
Rationale
Rework the log message into a more machine-parseable format. Note, that I've slightly updated how the signing works (we now sign the heartbeat payload object instead of array).
The JSON log message would be:
{"context":{"airnode":"0xbF3137b0a7574563a23a8fC8badC6537F98197CC","configHash":"0x126e768ba244efdb790d63a76821047e163dfc502ace09b2546a93075594c286","currentTimestamp":"1674172803","deploymentTimestamp":"1674172800","nodeVersion":"0.1.0","signature":"0x180b77067b4c319f97fd9b0ff5d6dcbaa02647d0a41497a2256a3b8a42d5f5b16301d1b10fd899c5cba40ea165b4a8fcde7c6e486b21141f5289c0d288c2436f1c","stage":"test"},"level":"info","message":"Sending heartbeat log","ms":"+0ms","timestamp":"2023-01-20T00:00:03.000Z"}You can identify the heartbeat log by the
messagefield. The payload will be insidecontextfield.(You can verify this by changing
jest.spyOn(heartbeatLogger, 'info').mockImplementation();tojest.spyOn(heartbeatLogger, 'info')and runningLOG_FORMAT=json pnpm run test heartin the heartbeat test)