onflow / onflow/flowkit

[FEATURE] Logging

Open
#6 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
8
Forks
11
Avg merge
5d 59m
Merged PRs (30d)
1

Description

Issue to be solved

Atm flowkit uses a custom logger that includes a spinner that is deferred. This means that when using flowkit in a service it is not possible to turn on the debug/spinner log since then all output in that service is garbled by this spinner.

Suggest A Solution

Introduce a logging framework like zerolog that is used in many other apps and move the spinner code to flow-cli repo. If needed split up methods that require multipe spinner in cli, but keep the old impl as is for bc.

What are you currently working on that this is blocking?

I am investigating an corner case in flowdiver ingestion engine where crescendo is flaky but the other networks are not. The lack of good observability hurts.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating flowkit's custom logger and deferred spinner implementation, then inspect how logging is used in service and CLI contexts. Done means service output is no longer garbled when debug logging is enabled, spinner behavior is moved to flow-cli as appropriate, and backward compatibility is preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.