Skip to content

Commit

Permalink
Add android specific debug info
Browse files Browse the repository at this point in the history
  • Loading branch information
vlabo committed Jan 17, 2023
1 parent 0d13bca commit 5a9e764
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 39 deletions.
2 changes: 1 addition & 1 deletion api/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func registerConfig() error {
err = config.Register(&config.Option{
Name: "API Keys",
Key: CfgAPIKeys,
Description: "Define API keys for priviledged access to the API. Every entry is a separate API key with respective permissions. Format is `<key>?read=<perm>&write=<perm>`. Permissions are `anyone`, `user` and `admin`, and may be omitted.",
Description: "Define API keys for privileged access to the API. Every entry is a separate API key with respective permissions. Format is `<key>?read=<perm>&write=<perm>`. Permissions are `anyone`, `user` and `admin`, and may be omitted.",
Sensitive: true,
OptType: config.OptTypeStringArray,
ExpertiseLevel: config.ExpertiseLevelDeveloper,
Expand Down
4 changes: 2 additions & 2 deletions log/output.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ type (

// AdapterFunc is a convenience type for implementing
// Adapter.
AdapterFunc func(msg Message, duplciates uint64)
AdapterFunc func(msg Message, duplicates uint64)

// FormatFunc formats msg into a string.
FormatFunc func(msg Message, duplciates uint64) string
FormatFunc func(msg Message, duplicates uint64) string

// SimpleFileAdapter implements Adapter and writes all
// messages to File.
Expand Down
36 changes: 0 additions & 36 deletions utils/debug/debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@ package debug

import (
"bytes"
"context"
"fmt"
"runtime/pprof"
"strings"
"time"

"github.com/shirou/gopsutil/host"

"github.com/safing/portbase/info"
"github.com/safing/portbase/log"
"github.com/safing/portbase/modules"
Expand Down Expand Up @@ -94,39 +91,6 @@ func (di *Info) AddVersionInfo() {
)
}

// AddPlatformInfo adds OS and platform information.
func (di *Info) AddPlatformInfo(ctx context.Context) {
// Get information from the system.
info, err := host.InfoWithContext(ctx)
if err != nil {
di.AddSection(
"Platform Information",
NoFlags,
fmt.Sprintf("Failed to get: %s", err),
)
return
}

// Check if we want to add virtulization information.
var virtInfo string
if info.VirtualizationRole == "guest" {
if info.VirtualizationSystem != "" {
virtInfo = fmt.Sprintf("VM: %s", info.VirtualizationSystem)
} else {
virtInfo = "VM: unidentified"
}
}

// Add section.
di.AddSection(
fmt.Sprintf("Platform: %s %s", info.Platform, info.PlatformVersion),
UseCodeSection|AddContentLineBreaks,
fmt.Sprintf("System: %s %s (%s) %s", info.Platform, info.OS, info.PlatformFamily, info.PlatformVersion),
fmt.Sprintf("Kernel: %s %s", info.KernelVersion, info.KernelArch),
virtInfo,
)
}

// AddGoroutineStack adds the current goroutine stack.
func (di *Info) AddGoroutineStack() {
buf := new(bytes.Buffer)
Expand Down
29 changes: 29 additions & 0 deletions utils/debug/debug_android.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package debug

import (
"context"
"fmt"

"github.com/safing/portmaster-android/go/app_interface"
)

// AddPlatformInfo adds OS and platform information.
func (di *Info) AddPlatformInfo(_ context.Context) {
// Get information from the system.
info, err := app_interface.GetPlatformInfo()
if err != nil {
di.AddSection(
"Platform Information",
NoFlags,
fmt.Sprintf("Failed to get: %s", err),
)
return
}

// Add section.
di.AddSection(
fmt.Sprintf("Platform: Android %s", info.VersionCode),
UseCodeSection|AddContentLineBreaks,
fmt.Sprintf("SDK: %d %s", info.SDK, info.Incremental),
fmt.Sprintf("Device: %s %s (%s)", info.Manufacturer, info.Brand, info.Board))
}
43 changes: 43 additions & 0 deletions utils/debug/debug_default.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
//go:build !android

package debug

import (
"context"
"fmt"

"github.com/shirou/gopsutil/host"
)

// AddPlatformInfo adds OS and platform information.
func (di *Info) AddPlatformInfo(ctx context.Context) {
// Get information from the system.
info, err := host.InfoWithContext(ctx)
if err != nil {
di.AddSection(
"Platform Information",
NoFlags,
fmt.Sprintf("Failed to get: %s", err),
)
return
}

// Check if we want to add virtulization information.
var virtInfo string
if info.VirtualizationRole == "guest" {
if info.VirtualizationSystem != "" {
virtInfo = fmt.Sprintf("VM: %s", info.VirtualizationSystem)
} else {
virtInfo = "VM: unidentified"
}
}

// Add section.
di.AddSection(
fmt.Sprintf("Platform: %s %s", info.Platform, info.PlatformVersion),
UseCodeSection|AddContentLineBreaks,
fmt.Sprintf("System: %s %s (%s) %s", info.Platform, info.OS, info.PlatformFamily, info.PlatformVersion),
fmt.Sprintf("Kernel: %s %s", info.KernelVersion, info.KernelArch),
virtInfo,
)
}

0 comments on commit 5a9e764

Please sign in to comment.