bigwhite / functrace

functrace

Quick Start

Install gen

$go get github.com/bigwhite/functrace/cmd/gen

And make sure the gen executable file is configured as part of the PATH env variable.

Generate trace entry for your packages

See the demo case: https://github.com/bigwhite/functrace/tree/main/examples/gen-demo

Add trace in batches

You can use the scripts/batch_add_trace.sh to add trace in batches for all go source files in some repo.

for example:

let's add trace in batches for github.com/panjf2000/gnet, the steps is below:

• git clone https://github.com/panjf2000/gnet.git
• cd gnet
• execute the following command:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/bigwhite/functrace/main/scripts/batch_add_trace.sh)"

If the access to github.com is very slow in your area, then you can copy scripts/batch_add_trace.sh of functrace to gnet dir and execute bash batch_add_trace.sh.

The command will output:

[gen -w ./ringbuffer/ring_buffer_test.go]
add trace for ./ringbuffer/ring_buffer_test.go ok
[gen -w ./ringbuffer/ring_buffer.go]
add trace for ./ringbuffer/ring_buffer.go ok
... ...
[gen -w ./internal/netpoll/queue/queue.go]
no trace added for ./internal/netpoll/queue/queue.go
[gen -w ./gnet.go]
add trace for ./gnet.go ok
[gen -w ./acceptor_windows.go]
add trace for ./acceptor_windows.go ok

After debugging, you can use 'git checkout .' to recover the origin status of your local workspace.

functrace's Issues

Add flag to ignore vendor folder

the build tags in comments removed by gen command

If the source file has comments , after handling by gen command, the comments will be removed. if the source file has build tags, the build tags will be also removed. this could cause compile error when build.

origin source file:

// Copyright (c) 2019 Andy Pan
   Copyright (c) 2018 Joshua J Baker
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

// +build linux freebsd dragonfly darwin

package gnet

import (
    "runtime"
    "sync"
    "sync/atomic"
    "time"

    "github.com/panjf2000/gnet/errors"
    "github.com/panjf2000/gnet/internal/logging"
    "github.com/panjf2000/gnet/internal/netpoll"
)

... 

after gen, it will look like below：

package gnet
  
import (
    "runtime"
    "sync"
    "sync/atomic"
    "time"

    "github.com/bigwhite/functrace"
    "github.com/panjf2000/gnet/errors"
    "github.com/panjf2000/gnet/internal/logging"
    "github.com/panjf2000/gnet/internal/netpoll"
)

generate empty file when pass option -w

when the source file passed to gen command(with option -w) is like below:

// github.com/panjf2000/internal/netpoll/queue/queue.go
package queue

// Task is a asynchronous function.
type Task func() error

// AsyncTaskQueue is a queue storing asynchronous tasks.
type AsyncTaskQueue interface {
    Enqueue(Task)
    Dequeue() Task
    Empty() bool
}

then，gen command generate an empty queue.go with success hint.

simplified the script generation way

Script generation can be simplified in the following way:
replace:

cp the scripts/batch_add_trace.sh of functrace to gnet dir
execute bash batch_add_trace.sh and it will output:

with

# execute in gnet dir:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/bigwhite/functrace/main/scripts/batch_add_trace.sh)"