** Copyright (C) 2001-2025 Zabbix SIA
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
** This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
** without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
** See the GNU Affero General Public License for more details.
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
"golang.zabbix.com/sdk/conf"
"golang.zabbix.com/sdk/errs"
"golang.zabbix.com/sdk/plugin"
// Session is a general structure for storing sessions' configuration.
URI string `conf:"name=Uri,optional"`
Password string `conf:"optional"`
User string `conf:"optional"`
TLSConnect string `conf:"name=TLSConnect,optional"`
TLSCAFile string `conf:"name=TLSCAFile,optional"`
TLSCertFile string `conf:"name=TLSCertFile,optional"`
TLSKeyFile string `conf:"name=TLSKeyFile,optional"`
// PluginOptions option from config file
type PluginOptions struct {
// Timeout is the maximum time in seconds for waiting when a connection has to be established.
// Default value equals to the global timeout.
Timeout int `conf:"optional,range=1:30"`
// CallTimeout is the maximum time in seconds for waiting when a request has to be done.
// Default value equals to the global agent timeout.
CallTimeout int `conf:"optional,range=1:30"`
// KeepAlive is a time to wait before unused connections will be closed.
KeepAlive int `conf:"optional,range=60:900,default=300"`
// Sessions stores pre-defined named sets of connections settings.
Sessions map[string]Session `conf:"optional"`
// CustomQueriesPath is a full pathname of a directory containing *.sql files with custom queries.
CustomQueriesPath string `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 *Plugin) Configure(global *plugin.GlobalOptions, options interface{}) {
if err := conf.UnmarshalStrict(options, &p.options); err != nil {
p.Errf("cannot unmarshal configuration options: %s", err)