Example loadable plugin
Source
/*
** Copyright (C) 2001-2024 Zabbix SIA
**
** Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
** documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
** rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
** permit persons to whom the Software is furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in all copies or substantial portions
** of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
** WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
** COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
** SOFTWARE.
**/
package plugin
import (
"golang.zabbix.com/sdk/conf"
"golang.zabbix.com/sdk/errs"
"golang.zabbix.com/sdk/plugin"
)
type session struct {
Username string `conf:"optional"`
Password string `conf:"optional"`
}
type pluginConfig struct {
// Timeout.
Timeout int `conf:"optional,range=1:30"`
// Sessions stores pre-defined named sets of connections settings.
Sessions map[string]session `conf:"optional"`
// Default stores default connection parameter values from configuration file.
Default session `conf:"optional"`
}
// Configure implements the Configurator interface.
// Initializes configuration structures.
func (p *examplePlugin) Configure(global *plugin.GlobalOptions, options any) {
pConfig := &pluginConfig{}
err := conf.UnmarshalStrict(options, pConfig)
if err != nil {
p.Errf("cannot unmarshal configuration options: %s", err.Error())
return
}
p.config = pConfig
if p.config.Timeout == 0 {
p.config.Timeout = global.Timeout
}
}
// Validate implements the Configurator interface.
// Returns an error if validation of a plugin's configuration is failed.
func (*examplePlugin) Validate(options any) error {
var opts pluginConfig