info

Documentation

Overview

Package info provides build-time info

Copyright (C) 2019-2022 vdaas.org vald team <vald@vdaas.org>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Init(name string)
• func String() string
• type Detail
  • func Get() Detail
  • func (d Detail) String() string
• type Info
  • func New(opts ...Option) (Info, error)
• type Option
  • func WithRuntimeCaller(f func(skip int) (pc uintptr, file string, line int, ok bool)) Option
  • func WithRuntimeFuncForPC(f func(pc uintptr) *runtime.Func) Option
  • func WithServerName(s string) Option
• type StackTrace
  • func (s StackTrace) String() string

Variables

var (

	// Version represent Vald version.
	Version = "v0.0.1"
	// GitCommit represent the Vald GitCommit
	GitCommit = "master"
	// BuildTime represent the Vald Build time.
	BuildTime = ""
	// GoVersion represent the golang version to build Vald.
	GoVersion string
	// GoOS represent the OS version of golang to build Vald.
	GoOS string
	// GoArch represent the architecture target to build Vald.
	GoArch string
	// CGOEnabled represent the cgo is enable or not to build Vald.
	CGOEnabled string
	// NGTVersion represent the NGT version in Vald.
	NGTVersion string
	// BuildCPUInfoFlags represent the CPU info flags to build Vald.
	BuildCPUInfoFlags string

	// Organization represent the organization of Vald.
	Organization = "vdaas"
	// Repository represent the repository of Vald.
	Repository = "vald"
)

Functions

func Init

func Init(name string)

Init initializes Detail object only once.

func String

func String() string

String calls String method of global detail object.

Types

type Detail

type Detail struct {
	Version           string       `json:"vald_version,omitempty"         yaml:"vald_version,omitempty"`
	ServerName        string       `json:"server_name,omitempty"          yaml:"server_name,omitempty"`
	GitCommit         string       `json:"git_commit,omitempty"           yaml:"git_commit,omitempty"`
	BuildTime         string       `json:"build_time,omitempty"           yaml:"build_time,omitempty"`
	GoVersion         string       `json:"go_version,omitempty"           yaml:"go_version,omitempty"`
	GoOS              string       `json:"go_os,omitempty"                yaml:"go_os,omitempty"`
	GoArch            string       `json:"go_arch,omitempty"              yaml:"go_arch,omitempty"`
	CGOEnabled        string       `json:"cgo_enabled,omitempty"          yaml:"cgo_enabled,omitempty"`
	NGTVersion        string       `json:"ngt_version,omitempty"          yaml:"ngt_version,omitempty"`
	BuildCPUInfoFlags []string     `json:"build_cpu_info_flags,omitempty" yaml:"build_cpu_info_flags,omitempty"`
	StackTrace        []StackTrace `json:"stack_trace,omitempty"          yaml:"stack_trace,omitempty"`
}

Detail represents environment information of system and stacktrace information.

func Get

func Get() Detail

Get calls Get method of global detail object.

func (Detail) String

func (d Detail) String() string

String returns summary of Detail object.

type Info

type Info interface {
	String() string
	Get() Detail
}

Info represents an interface to get the runtime information.

func New

func New(opts ...Option) (Info, error)

New initializes and returns the info object or any error occurred.

type Option

type Option func(i *info) error

Option represent the functional option for info.

func WithRuntimeCaller

func WithRuntimeCaller(f func(skip int) (pc uintptr, file string, line int, ok bool)) Option

WithRuntimeCaller returns the option to set the runtime Caller function.

func WithRuntimeFuncForPC

func WithRuntimeFuncForPC(f func(pc uintptr) *runtime.Func) Option

WithRuntimeFuncForPC returns the option to set the runtime FuncForPC function.

func WithServerName

func WithServerName(s string) Option

WithServerName returns the option to set the server name.

type StackTrace

type StackTrace struct {
	URL      string `json:"url,omitempty"           yaml:"url,omitempty"`
	FuncName string `json:"function_name,omitempty" yaml:"func_name,omitempty"`
	File     string `json:"file,omitempty"          yaml:"file,omitempty"`
	Line     int    `json:"line,omitempty"          yaml:"line,omitempty"`
}

StackTrace represents stacktrace information about url, function name, file, line ..etc.

func (StackTrace) String

func (s StackTrace) String() string