canonical/multipass

Instrument function calls to debug-log arguments and return values

Open

#428 opened on Oct 3, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C++ (634 forks)batch import
enhancementgood first issuelow hanging fruit

Repository metrics

Stars
 (6,956 stars)
PR merge metrics
 (Avg merge 16d 2h) (50 merged PRs in 30d)

Description

When debugging, it's currently very difficult to know the function flow even from our debug logs.

Ideally, every function call would log its input arguments and return values, even better - without being specifically instrumented. There are some compiler features for this, but difficult and may be overkill.

We might need to add a trace logging level for this.

Contributor guide

Research direction
Explore GCC's finstrument functions and implement a 'trace' log level for automatic logging of function arguments and return values.
Tech stack
cpp
Domain
observability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45