flagtrace

Documentation

Overview

Package flagtrace provides easy tracing of the program (using runtime/trace) by enabling a command-line flag.

Index

• func Register(flags *flag.FlagSet, flagName string, usage string) (stopTracing func())

Examples

• Register

Functions

func Register

func Register(flags *flag.FlagSet, flagName string, usage string) (stopTracing func())

Register registers a flag to enable tracing with runtime/trace.

The returned func must be run defered to stop the tracing and close the file.

When tracing is enabled, a handler for SIGINT (^C) is also registered to properly stop tracing and close the file.

Example

package main

import (
	"flag"
	"fmt"

	"github.com/dolmen-go/flagx/flagtrace"
)

func main() {
	stopTracing := flagtrace.Register(flag.CommandLine, "debug.trace", "trace `file` (for go tool trace)")
	defer stopTracing()

	flag.Parse()

	fmt.Println("hello, world!")

}

Output:

hello, world!