1
0
mirror of https://github.com/git/git.git synced 2024-11-15 17:03:14 +01:00
git/trace2/tr2_cmd_name.h
Jeff Hostetler ee4512ed48 trace2: create new combined trace facility
Create a new unified tracing facility for git.  The eventual intent is to
replace the current trace_printf* and trace_performance* routines with a
unified set of git_trace2* routines.

In addition to the usual printf-style API, trace2 provides higer-level
event verbs with fixed-fields allowing structured data to be written.
This makes post-processing and analysis easier for external tools.

Trace2 defines 3 output targets.  These are set using the environment
variables "GIT_TR2", "GIT_TR2_PERF", and "GIT_TR2_EVENT".  These may be
set to "1" or to an absolute pathname (just like the current GIT_TRACE).

* GIT_TR2 is intended to be a replacement for GIT_TRACE and logs command
  summary data.

* GIT_TR2_PERF is intended as a replacement for GIT_TRACE_PERFORMANCE.
  It extends the output with columns for the command process, thread,
  repo, absolute and relative elapsed times.  It reports events for
  child process start/stop, thread start/stop, and per-thread function
  nesting.

* GIT_TR2_EVENT is a new structured format. It writes event data as a
  series of JSON records.

Calls to trace2 functions log to any of the 3 output targets enabled
without the need to call different trace_printf* or trace_performance*
routines.

Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-02-22 15:27:59 -08:00

25 lines
660 B
C

#ifndef TR2_CMD_NAME_H
#define TR2_CMD_NAME_H
/*
* Append the current command name to the list being maintained
* in the environment.
*
* The hierarchy for a top-level git command is just the current
* command name. For a child git process, the hierarchy includes the
* names of the parent processes.
*
* The hierarchy for the current process will be exported to the
* environment and inherited by child processes.
*/
void tr2_cmd_name_append_hierarchy(const char *name);
/*
* Get the command name hierarchy for the current process.
*/
const char *tr2_cmd_name_get_hierarchy(void);
void tr2_cmd_name_release(void);
#endif /* TR2_CMD_NAME_H */