/* ** Zabbix ** Copyright (C) 2001-2023 Zabbix SIA ** ** This program is free software; you can redistribute it and/or modify ** it under the terms of the GNU General Public License as published by ** the Free Software Foundation; either version 2 of the License, or ** (at your option) any later version. ** ** 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 General Public License for more details. ** ** You should have received a copy of the GNU General Public License ** along with this program; if not, write to the Free Software ** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. **/ package oracle import ( "context" "errors" "net/http" "net/url" "strings" "time" "git.zabbix.com/ap/plugin-support/metric" "git.zabbix.com/ap/plugin-support/uri" "git.zabbix.com/ap/plugin-support/zbxerr" "github.com/omeid/go-yarn" "git.zabbix.com/ap/plugin-support/plugin" ) const ( pluginName = "Oracle" hkInterval = 10 sqlExt = ".sql" sysdbaExtension = " as sysdba" sysasmExtension = " as sysoper" sysoperExtension = " as sysasm" sysdbaPrivelege = "sysdba" sysasmPrivelege = "sysoper" sysoperPrivelege = "sysasm" ) // Plugin inherits plugin.Base and store plugin-specific data. type Plugin struct { plugin.Base connMgr *ConnManager options PluginOptions } // impl is the pointer to the plugin implementation. var impl Plugin // Export implements the Exporter interface. func (p *Plugin) Export(key string, rawParams []string, _ plugin.ContextProvider) (result interface{}, err error) { params, extraParams, hc, err := metrics[key].EvalParams(rawParams, p.options.Sessions) if err != nil { return nil, err } err = metric.SetDefaults(params, hc, p.options.Default) if err != nil { return nil, err } service := url.QueryEscape(params["Service"]) user, privilege, err := splitUserPrivilege(params) if err != nil { return nil, zbxerr.ErrorInvalidParams.Wrap(err) } uri, err := uri.NewWithCreds(params["URI"]+"?service="+service, user, params["Password"], uriDefaults) if err != nil { return nil, err } handleMetric := getHandlerFunc(key) if handleMetric == nil { return nil, zbxerr.ErrorUnsupportedMetric } conn, err := p.connMgr.GetConnection(connDetails{*uri, privilege}) if err != nil { // Special logic of processing connection errors should be used if oracle.ping is requested // because it must return pingFailed if any error occurred. if key == keyPing { return pingFailed, nil } p.Errf(err.Error()) return nil, err } ctx, cancel := context.WithTimeout(conn.ctx, conn.callTimeout) defer cancel() result, err = handleMetric(ctx, conn, params, extraParams...) if err != nil { p.Errf(err.Error()) } return result, err } // Start implements the Runner interface and performs initialization when plugin is activated. func (p *Plugin) Start() { p.connMgr = NewConnManager( time.Duration(p.options.KeepAlive)*time.Second, time.Duration(p.options.ConnectTimeout)*time.Second, time.Duration(p.options.CallTimeout)*time.Second, hkInterval*time.Second, p.setCustomQuery(), ) } func (p *Plugin) setCustomQuery() yarn.Yarn { if p.options.CustomQueriesPath == "" { return yarn.NewFromMap(map[string]string{}) } queryStorage, err := yarn.New(http.Dir(p.options.CustomQueriesPath), "*"+sqlExt) if err != nil { p.Errf(err.Error()) // create empty storage if error occurred return yarn.NewFromMap(map[string]string{}) } return queryStorage } // Stop implements the Runner interface and frees resources when plugin is deactivated. func (p *Plugin) Stop() { p.connMgr.Destroy() p.connMgr = nil } func splitUserPrivilege(params map[string]string) (user, privilege string, err error) { var ok bool user, ok = params["User"] if !ok { return "", "", errors.New("missing parameter 'User'") } var extension string switch true { case strings.HasSuffix(strings.ToLower(user), sysdbaExtension): privilege = sysdbaPrivelege extension = sysdbaExtension case strings.HasSuffix(strings.ToLower(user), sysoperExtension): privilege = sysoperPrivelege extension = sysoperExtension case strings.HasSuffix(strings.ToLower(user), sysasmExtension): privilege = sysasmPrivelege extension = sysasmExtension } return user[:len(user)-len(extension)], privilege, nil }