[sozo] add trace logs

[btirth]

Added trace logs for Sozo.
Closes #1409
Closes DOJ-160

[tarrencev]

Thanks for working on this!

[glihm]

Great work @btirth!

As @tarrencev mentioned, we should use structured logging everywhere.

You have the good convention with the LOG_TARGET, now you'll have to switch to the correct format where the text should be a sentence with a capital letter and punctuation.
And for the variables, you have to assign them depending on what should be printed.

If you have any question, please let's know. You can find several examples of this structured logging into the code base already.

[codecov]

Codecov Report

Attention: Patch coverage is 30.00000% with 105 lines in your changes are missing coverage. Please review.

Project coverage is 70.13%. Comparing base (6427cdc) to head (a741fa9).

Files	Patch %	Lines
bin/sozo/src/commands/auth.rs	0.00%	20 Missing ⚠️
bin/sozo/src/commands/options/fee.rs	0.00%	17 Missing ⚠️
bin/sozo/src/commands/account.rs	13.33%	13 Missing ⚠️
bin/sozo/src/commands/events.rs	0.00%	12 Missing ⚠️
bin/sozo/src/commands/dev.rs	0.00%	10 Missing ⚠️
bin/sozo/src/commands/migrate.rs	0.00%	9 Missing ⚠️
bin/sozo/src/commands/execute.rs	0.00%	6 Missing ⚠️
bin/sozo/src/commands/options/transaction.rs	16.66%	5 Missing ⚠️
bin/sozo/src/commands/build.rs	42.85%	4 Missing ⚠️
bin/sozo/src/commands/options/account.rs	42.85%	4 Missing ⚠️
... and 3 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1867      +/-   ##
==========================================
- Coverage   70.28%   70.13%   -0.15%     
==========================================
  Files         315      315              
  Lines       35864    35993     +129     
==========================================
+ Hits        25206    25244      +38     
- Misses      10658    10749      +91     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[glihm]

Thanks for the work here!
Some other comments.

Also, it seems that your editor is always removing empty line at the end of the files. It's preferable to have this new line at the end of the file.

[kariy]

i dont think we have to insert log for every stuff we're doing. it's only gonna introduce noise than actually useful info. i have sugggested some places where the logs can be removed.

besides, individual event logs arent particularly useful, i think its better to use spans wherever make sense instead (eg on the commands' main execution point)

wdyt @tarrencev @glihm ?

[lambda-0x]

thanks for the contribution!

i have few suggestion:

• i dont think we need to manually specify LOG_TARGET by default the package name would be used which i think is good
• for things like signer, world_address, which are static we should print them each in a single line (and preferrably during the beginning of execution) so they are easier to find.

[btirth]

@lambda-0x Thank you for your suggestions.

• I've take Katana logging as reference, if LOG_TARGET in Katana if for any specific reason then I'll remove it from Sozo.
• If we print signer and world_address on single line, there'll be no trace message for that log, as it doesn't make sense to copy same message. If that's fine I can do that as well.

[lambda-0x]

I've take Katana logging as reference, if LOG_TARGET in Katana if for any specific reason then I'll remove it from Sozo.

I think katana benefits from having a katana::cli namespace since most of its logging comes from core part of katana, but @kariy would have more info on why we do it that way for katana.

for sozo its not very useful since since we would need to manage them whenever doing any kind of refactor.

If we print signer and world_address on single line, there'll be no trace message for that log, as it doesn't make sense to copy same message. If that's fine I can do that as well.

i meant we should have a trace for each one of them in the beginning of sozo execution since they are static and wont change once they are calcuated (for e.g. world address if user hasn't specified it we take it from `Scarb.toml).

[glihm]

Could you please double check that fetched is only used when something is actually fetched from the network.

I've made some modifications in Events, but may have missed some.

[btirth]

Are any changes required or can we merge this one?

[lambda-0x]

@btirth can you please take a look at CI failures, try running the command they run locally.

[btirth]

@lambda-0x: I've fixed CI failures.

[glihm]

Thanks for your patience and iteration @btirth!
I you could address the latest comments, will merge after that. Great work!

[glihm]

@btirth thanks for the work here!