plugin

Documentation

Index

• Constants
• func GetLogger() *slog.Logger
• func Run(scanner types.Scanner)

Constants

const (
	EnvLogLevel     = "PLUGIN_SERVER_LOG_LEVEL"
	DefaultLogLevel = "info"

	EnvListenAddress     = "PLUGIN_SERVER_LISTEN_ADDRESS"
	DefaultListenAddress = "http://0.0.0.0:8080"
)

const APIVersion = "1.0.0"

APIVersion defines the current version of the Scanner Plugin API.

Functions

func GetLogger

func GetLogger() *slog.Logger

GetLogger defines JSON logger that outputs to stdout with level loaded fom EnvLogLevel.

func Run

func Run(scanner types.Scanner)

Run starts Plugin HTTP Server and uses provided Scanner to respond to requests. Run logs data to standard output using GetLogger. This operation blocks until exit. It handles graceful termination. Server listens on address loaded from EnvListenAddress. It exists with exit code 1 on error. Run simplifies the main logic. Can only be called once.

Usage example:

import (

"github.com/openclarity/vmclarity/plugins/sdk-go/plugin"
"github.com/openclarity/vmclarity/plugins/sdk-go/types"
)

func main() {
     var myScanner types.Scanner    // your implementation of Scanner interface
     plugin.Run(myScanner)          // start server until exit
}