https://github.com/go-stack/stack

Package stack implements utilities to capture, manipulate, and format call stacks.
https://github.com/go-stack/stack

go golang stacktrace

Last synced: 3 months ago
JSON representation

Package stack implements utilities to capture, manipulate, and format call stacks.

• Host: GitHub
• URL: https://github.com/go-stack/stack
• Owner: go-stack
• License: mit
• Created: 2014-10-30T02:31:57.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2021-08-18T18:48:25.000Z (over 3 years ago)
• Last Synced: 2024-10-19T19:40:01.275Z (3 months ago)
• Topics: go, golang, stacktrace
• Language: Go
• Homepage:
• Size: 1.12 MB
• Stars: 396
• Watchers: 7
• Forks: 34
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• go-awesome - stack - Capture, edit and format call stack information (Open source library / Debugging)

README

        
[![GoDoc](https://godoc.org/github.com/go-stack/stack?status.svg)](https://godoc.org/github.com/go-stack/stack)

[![Go Report Card](https://goreportcard.com/badge/go-stack/stack)](https://goreportcard.com/report/go-stack/stack)

[![TravisCI](https://travis-ci.org/go-stack/stack.svg?branch=master)](https://travis-ci.org/go-stack/stack)

[![Coverage Status](https://coveralls.io/repos/github/go-stack/stack/badge.svg?branch=master)](https://coveralls.io/github/go-stack/stack?branch=master)

# stack

Package stack implements utilities to capture, manipulate, and format call

stacks. It provides a simpler API than package runtime.

The implementation takes care of the minutia and special cases of interpreting

the program counter (pc) values returned by runtime.Callers.

## Versioning

Package stack publishes releases via [semver](http://semver.org/) compatible Git

tags prefixed with a single 'v'. The master branch always contains the latest

release. The develop branch contains unreleased commits.

## Formatting

Package stack's types implement fmt.Formatter, which provides a simple and

flexible way to declaratively configure formatting when used with logging or

error tracking packages.

```go

func DoTheThing() {

    c := stack.Caller(0)

    log.Print(c)          // "source.go:10"

    log.Printf("%+v", c)  // "pkg/path/source.go:10"

    log.Printf("%n", c)   // "DoTheThing"

    s := stack.Trace().TrimRuntime()

    log.Print(s)          // "[source.go:15 caller.go:42 main.go:14]"

}

```

See the docs for all of the supported formatting options.