bugtrack

Documentation

Overview

Package bugtrack enables the bug tracking system, which is comprised of a global logger that will write to Standard Error and on the filesystem in a temporary directory, "$TEMP" in *nix and "%TEMP%" on Windows, that is named "bugtrack-<PID>.log".

To enable bug tracking, use the "bugs" build tag.

Index

• Constants
• func Recover(_ string)
• func Track(_ string, _ ...any)

Constants

const Enabled = false

Enabled is the stats of the bugtrack package.

This is true if bug tracking is enabled.

Functions

func Recover

func Recover(_ string)

Recover is a "guard" function to be used to gracefully shutdown a program when a panic is detected.

Can be en enabled by using:

if bugtrack.Enabled {
    defer bugtrack.Recover("thread-name")
}

The specified name will be entered into the bugtrack log and a stack trace will be generated before gracefully execution to the program.

func Track

func Track(_ string, _ ...any)

Track is a simple logging function that takes the same arguments as a 'fmt.Sprintf' function. This can be used to track bugs or output values.

Not recommended to be used in production environments.

The "-tags bugs" option is required in order for this function to be used.