Documentation
¶
Overview ¶
Copyright 2024 Google LLC
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
http://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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server contains info for running an instance of Toolbox. Should be instantiated with NewServer().
func NewServer ¶
func NewServer(cfg ServerConfig, log logLib.Logger) (*Server, error)
NewServer returns a Server object based on provided Config.
type ServerConfig ¶ added in v0.0.2
type ServerConfig struct {
// Server version
Version string
// Address is the address of the interface the server will listen on.
Address string
// Port is the port the server will listen on.
Port int
// SourceConfigs defines what sources of data are available for tools.
SourceConfigs SourceConfigs
// ToolConfigs defines what tools are available.
ToolConfigs ToolConfigs
// ToolsetConfigs defines what tools are available.
ToolsetConfigs ToolsetConfigs
// LoggingFormat defines whether structured loggings are used.
LoggingFormat logFormat
// LogLevel defines the levels to log
LogLevel StringLevel
}
type SourceConfigs ¶ added in v0.0.2
type SourceConfigs map[string]sources.SourceConfig
SourceConfigs is a type used to allow unmarshal of the data source config map
func (*SourceConfigs) UnmarshalYAML ¶ added in v0.0.2
func (c *SourceConfigs) UnmarshalYAML(node *yaml.Node) error
type StringLevel ¶ added in v0.0.3
type StringLevel string
func (*StringLevel) Set ¶ added in v0.0.3
func (s *StringLevel) Set(v string) error
validate log level flag
func (*StringLevel) String ¶ added in v0.0.3
func (s *StringLevel) String() string
String is used by both fmt.Print and by Cobra in help text
func (*StringLevel) Type ¶ added in v0.0.3
func (s *StringLevel) Type() string
Type is used in Cobra help text
type ToolConfigs ¶ added in v0.0.2
type ToolConfigs map[string]tools.ToolConfig
ToolConfigs is a type used to allow unmarshal of the tool configs
func (*ToolConfigs) UnmarshalYAML ¶ added in v0.0.2
func (c *ToolConfigs) UnmarshalYAML(node *yaml.Node) error
type ToolsetConfigs ¶ added in v0.0.2
type ToolsetConfigs map[string]tools.ToolsetConfig
ToolConfigs is a type used to allow unmarshal of the toolset configs
func (*ToolsetConfigs) UnmarshalYAML ¶ added in v0.0.2
func (c *ToolsetConfigs) UnmarshalYAML(node *yaml.Node) error
Source Files