input-output-hk / cardano-wallet-legacy

Official Wallet Backend & API for Cardano-SL
https://input-output-hk.github.io/cardano-wallet/
MIT License
21 stars 12 forks source link

Improve logging #315

Open denisshevchenko opened 5 years ago

denisshevchenko commented 5 years ago

Context

Our logging situation is terrible and not helpful. A lot of Buildable-instances are not as useful as we'd want. So we will need to fix these instances for pretty much every type we use to make sure that we get the most information we can out of our logging.That also probably mean getting rid of this BuildableSafe we did a while ago and just, not output password and private keys in the Buildable-instance at all.

Decision

  1. Review all Buildable-instances and check what outputs we get from the logs.
  2. (Probably) get rid of BuildableSafe-instances by removing them with Buildable-instances.
  3. Add a few actual log lines in the wallet code, apart from the API calls.

Acceptance Criterias


Development Plan

Proposal - open a separate PR for each layer:

  1. Buildable-instances in API-layer.
  2. Buildable-instances in Wallet-layer.
  3. Buildable-instances in Kernel-layer.
  4. Buildable-instances in DB-layer.

PR

Number Base
#316 develop
#345 develop
#348 develop
#352 develop
#358 develop
#361 develop
#363 develop

QA

Criteria Coverage
? -

Retrospective

akegalj commented 5 years ago

Replace BuildableSafeGen-instances by corresponding Buildable-instances and make sure we don't print out passwords and private keys. BuildableSafeGen-instances must be removed from these modules:

I am not sure this is what we want? We are going to lose privacy option for our logs which we do want in production setting. Some people wouldn't want their account names being leaked into logs