Adding Correlation id to the logs #1906
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
Vovchyk
requested changes
Oct 27, 2022
rskj-core/src/main/java/co/rsk/rpc/netty/Web3ResultHttpResponseHandler.java
Outdated
Show resolved
Hide resolved
rskj-core/src/main/java/co/rsk/rpc/netty/LogTracingFilterHandler.java
Outdated
Show resolved
Hide resolved
Vovchyk
requested changes
Oct 28, 2022
rskj-core/src/main/java/co/rsk/rpc/netty/LogTracingFilterHandler.java
Outdated
Show resolved
Hide resolved
asoto-iov
force-pushed
the
feature/adding_correlation_id_to_logs
branch
2 times, most recently
from
36ffca8
to
2cab4ab
Compare
|
@asoto-iov , tests are failing. Please check |
|
pipeline:run |
Vovchyk
requested changes
Oct 31, 2022
| @@ -0,0 +1,18 @@ | |||
| package co.rsk.util; | |||
| class TraceUtilsTest{ | ||
|
|
||
| @Test | ||
| void testToId() { |
There was a problem hiding this comment.
I guess we should also cover other cases, eg. when the test value is null, its length is less than 15 etc
|
Kudos, SonarCloud Quality Gate passed! |
Vovchyk
previously approved these changes
Oct 31, 2022
|
pipeline:run |
3 similar comments
|
pipeline:run |
|
pipeline:run |
|
pipeline:run |
asoto-iov
force-pushed
the
feature/adding_correlation_id_to_logs
branch
from
38fb03b
to
b742e78
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| RskMessage rskmessage = (RskMessage) msg; | ||
| Message message = rskmessage.getMessage(); | ||
|
|
||
| switch (message.getMessageType()) { |
Check warning
Code scanning / CodeQL
Missing enum case in switch
|
|
||
| import static org.junit.jupiter.api.Assertions.*; | ||
|
|
||
| class TraceUtilsTest { |
Check notice
Code scanning / CodeQL
Unused classes and interfaces
|
Kudos, SonarCloud Quality Gate passed! |
|
pipeline:run |
Vovchyk
approved these changes
Jan 23, 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.
Adding correlation id's to the logs in order to have a better tracking.
To see the logs it would be helpful to set the following log levels:
web3 -> DEBUG
net -> TRACE
wire -> TRACE
messagehandler -> TRACE
Description
The idea is to create unique identifiers for each action and use it to relate the different logged data along the code.
This is a draft to test possible solutions in different areas/modules.
Motivation and Context
Now is hard and track different actions by checking the logs as similar actions are being executed in parallel by different threads.
How Has This Been Tested?
It doesn't have side effects in other areas.
[JSON-RPC]
To check it you can send any JSON-RPC request and check the trace.id value in the logs.
The trace id is being generated randomly but you can add a custom one by adding a custom header
X-TRACE-IDin the request.curl --location --request POST 'http://localhost:4444' \ --header 'Content-Type: application/json' \ --header 'X-TRACE-ID: custom_header_value' \ --data-raw '{ "jsonrpc":"2.0", "method":"web3_clientVersion", "params":[], "id":1 }'Types of changes
It is a new feature
Checklist: