pluginmanager

Documentation

Index

• Constants
• func FindPluginFolder(remoteSchema string) (string, error)
• func GetPluginManager() (pluginshared.PluginManager, error)
• func GetPluginPath(plugin, pluginShortName string) (string, error)
• func PluginFQNToSchemaName(pluginFQN string) string
• func StartNewInstance(steampipeExecutablePath string) error
• func Stop() error
• type LegacyPluginManagerState
• type PluginManager
  • func NewPluginManager(connectionConfig map[string]*pb.ConnectionConfig, logger hclog.Logger) *PluginManager
  • func (m *PluginManager) Get(req *pb.GetRequest) (*pb.GetResponse, error)
  • func (m *PluginManager) Serve()
  • func (m *PluginManager) SetConnectionConfigMap(configMap map[string]*pb.ConnectionConfig)
  • func (m *PluginManager) Shutdown(req *pb.ShutdownRequest) (resp *pb.ShutdownResponse, err error)
• type PluginManagerClient
  • func NewPluginManagerClient(pluginManagerState *PluginManagerState) (*PluginManagerClient, error)
  • func (c *PluginManagerClient) Get(req *pb.GetRequest) (res *pb.GetResponse, err error)
  • func (c *PluginManagerClient) Shutdown(req *pb.ShutdownRequest) (res *pb.ShutdownResponse, err error)
• type PluginManagerState
  • func LoadPluginManagerState() (*PluginManagerState, error)
  • func NewPluginManagerState(executable string, reattach *plugin.ReattachConfig) *PluginManagerState
  • func (s PluginManagerState) IsValid() bool
  • func (s *PluginManagerState) MigrateFrom(prev interface{}) migrate.Migrateable
  • func (s *PluginManagerState) Save() error

Constants

const PluginManagerStructVersion = 20220411

Functions

func FindPluginFolder

func FindPluginFolder(remoteSchema string) (string, error)

FindPluginFolder searches for a folder which when hashed would match the schema

func GetPluginManager

func GetPluginManager() (pluginshared.PluginManager, error)

GetPluginManager connects to a running plugin manager

func GetPluginPath

func GetPluginPath(plugin, pluginShortName string) (string, error)

func PluginFQNToSchemaName

func PluginFQNToSchemaName(pluginFQN string) string

PluginFQNToSchemaName convert a full plugin name to a schema name schemas in postgres are limited to 63 chars - the name may be longer than this, in which case trim the length and add a hash to the end to make unique

func StartNewInstance

func StartNewInstance(steampipeExecutablePath string) error

StartNewInstance loads the plugin manager state, stops any previous instance and instantiates a new plugin manager

func Stop

func Stop() error

Stop loads the plugin manager state and if a running instance is found, stop it

Types

type LegacyPluginManagerState

type LegacyPluginManagerState struct {
	Protocol        plugin.Protocol
	ProtocolVersion int
	Addr            *pb.SimpleAddr
	Pid             int
	// path to the steampipe executable
	Executable string
	// is the plugin manager running
	Running bool `json:"-"`
}

LegacyPluginManagerState is a struct used to migrate the PluginManagerState to serialize with snake case property names(migrated in v0.14.0)

type PluginManager

type PluginManager struct {
	pb.UnimplementedPluginManagerServer

	Plugins map[string]*runningPlugin
	// contains filtered or unexported fields
}

PluginManager is the real implementation of grpc.PluginManager

func NewPluginManager

func NewPluginManager(connectionConfig map[string]*pb.ConnectionConfig, logger hclog.Logger) *PluginManager

func (*PluginManager) Get

func (m *PluginManager) Get(req *pb.GetRequest) (*pb.GetResponse, error)

func (*PluginManager) Serve

func (m *PluginManager) Serve()

func (*PluginManager) SetConnectionConfigMap

func (m *PluginManager) SetConnectionConfigMap(configMap map[string]*pb.ConnectionConfig)

func (*PluginManager) Shutdown

func (m *PluginManager) Shutdown(req *pb.ShutdownRequest) (resp *pb.ShutdownResponse, err error)

type PluginManagerClient

type PluginManagerClient struct {
	// contains filtered or unexported fields
}

PluginManagerClient is the client used by steampipe to access the plugin manager

func NewPluginManagerClient

func NewPluginManagerClient(pluginManagerState *PluginManagerState) (*PluginManagerClient, error)

func (*PluginManagerClient) Get

func (c *PluginManagerClient) Get(req *pb.GetRequest) (res *pb.GetResponse, err error)

func (*PluginManagerClient) Shutdown

func (c *PluginManagerClient) Shutdown(req *pb.ShutdownRequest) (res *pb.ShutdownResponse, err error)

type PluginManagerState

type PluginManagerState struct {
	Protocol        plugin.Protocol `json:"protocol"`
	ProtocolVersion int             `json:"protocol_version"`
	Addr            *pb.SimpleAddr  `json:"addr"`
	Pid             int             `json:"pid"`
	// path to the steampipe executable
	Executable string `json:"executable"`
	// is the plugin manager running
	Running       bool  `json:"-"`
	StructVersion int64 `json:"struct_version"`
}

func LoadPluginManagerState

func LoadPluginManagerState() (*PluginManagerState, error)

func NewPluginManagerState

func NewPluginManagerState(executable string, reattach *plugin.ReattachConfig) *PluginManagerState

func (PluginManagerState) IsValid

func (s PluginManagerState) IsValid() bool

IsValid checks whether the struct was correctly deserialized, by checking if the StructVersion is populated

func (*PluginManagerState) MigrateFrom

func (s *PluginManagerState) MigrateFrom(prev interface{}) migrate.Migrateable

func (*PluginManagerState) Save

func (s *PluginManagerState) Save() error