vikarti.anatra/safing-portbase
1
0
Fork 0
mirror of https://github.com/safing/portbase synced 2025-09-09 13:55:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Implement review suggestions

Browse source
This commit is contained in:
Daniel 2021-01-08 16:46:11 +01:00
parent 7c7340c2e7
commit 4b2bfc3e8f
3 changed files with 19 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

32
utils/debug/debug.go
View file

@ -13,40 +13,40 @@ import (
"github.com/shirou/gopsutil/host"
)
// DebugInfo gathers debugging information and stores everything in a buffer in
// Info gathers debugging information and stores everything in a buffer in
// order to write it to somewhere later. It directly inherits a bytes.Buffer,
// so you can also use all these functions too.
type DebugInfo struct {
type Info struct {
bytes.Buffer
Style string
}
// DebugInfoFlag defines possible options for adding sections to a DebugInfo.
type DebugInfoFlag int
// InfoFlag defines possible options for adding sections to a Info.
type InfoFlag int
const (
// NoFlags does nothing.
NoFlags DebugInfoFlag = 0
NoFlags InfoFlag = 0
// UseCodeSection wraps the section content in a markdown code section.
UseCodeSection DebugInfoFlag = 1
UseCodeSection InfoFlag = 1
// AddContentLineBreaks adds a line breaks after each line of content,
// except for the last.
AddContentLineBreaks DebugInfoFlag = 2
AddContentLineBreaks InfoFlag = 2
)
func useCodeSection(flags DebugInfoFlag) bool {
func useCodeSection(flags InfoFlag) bool {
return flags&UseCodeSection > 0
}
func addContentLineBreaks(flags DebugInfoFlag) bool {
func addContentLineBreaks(flags InfoFlag) bool {
return flags&AddContentLineBreaks > 0
}
// AddSection adds a debug section to the DebugInfo. The result is directly
// AddSection adds a debug section to the Info. The result is directly
// written into the buffer.
func (di *DebugInfo) AddSection(name string, flags DebugInfoFlag, content ...string) {
func (di *Info) AddSection(name string, flags InfoFlag, content ...string) {
// Check if we need a spacer.
if di.Len() > 0 {
di.WriteString("\n\n")
@ -84,7 +84,7 @@ func (di *DebugInfo) AddSection(name string, flags DebugInfoFlag, content ...str
}
// AddVersionInfo adds version information from the info pkg.
func (di *DebugInfo) AddVersionInfo() {
func (di *Info) AddVersionInfo() {
di.AddSection(
"Version "+info.Version(),
UseCodeSection,
@ -93,7 +93,7 @@ func (di *DebugInfo) AddVersionInfo() {
}
// AddPlatformInfo adds OS and platform information.
func (di *DebugInfo) AddPlatformInfo(ctx context.Context) {
func (di *Info) AddPlatformInfo(ctx context.Context) {
// Get information from the system.
info, err := host.InfoWithContext(ctx)
if err != nil {
@ -126,7 +126,7 @@ func (di *DebugInfo) AddPlatformInfo(ctx context.Context) {
}
// AddGoroutineStack adds the current goroutine stack.
func (di *DebugInfo) AddGoroutineStack() {
func (di *Info) AddGoroutineStack() {
buf := new(bytes.Buffer)
err := pprof.Lookup("goroutine").WriteTo(buf, 1)
if err != nil {
@ -147,7 +147,7 @@ func (di *DebugInfo) AddGoroutineStack() {
}
// AddLastReportedModuleError adds the last reported module error, if one exists.
func (di *DebugInfo) AddLastReportedModuleError() {
func (di *Info) AddLastReportedModuleError() {
me := modules.GetLastReportedError()
if me == nil {
di.AddSection("No Module Error", NoFlags)
@ -162,7 +162,7 @@ func (di *DebugInfo) AddLastReportedModuleError() {
}
// AddLastUnexpectedLogs adds the last 10 unexpected log lines, if any.
func (di *DebugInfo) AddLastUnexpectedLogs() {
func (di *Info) AddLastUnexpectedLogs() {
lines := log.GetLastUnexpectedLogs()
// Check if there is anything at all.