initial fix

This commit is contained in:
yesoreyeram
2025-01-03 09:18:37 +00:00
parent dbcc008489
commit 374c83d17d
5 changed files with 143 additions and 30 deletions

View File

@@ -494,13 +494,7 @@ func (ds *Zabbix) GetAllGroups(ctx context.Context) ([]Group, error) {
params := ZabbixAPIParams{ params := ZabbixAPIParams{
"output": []string{"name", "groupid"}, "output": []string{"name", "groupid"},
"sortfield": "name", "sortfield": "name",
} "with_hosts": true,
// Zabbix v7.0 and later removed `real_hosts` parameter and replaced it with `with_hosts`
if ds.version < 70 {
params["real_hosts"] = true
} else {
params["with_hosts"] = true
} }
result, err := ds.Request(ctx, &ZabbixAPIRequest{Method: "hostgroup.get", Params: params}) result, err := ds.Request(ctx, &ZabbixAPIRequest{Method: "hostgroup.get", Params: params})

View File

@@ -0,0 +1,84 @@
package zabbixapi
import (
"context"
"github.com/grafana/grafana-plugin-sdk-go/backend/log"
)
func normalizeParams(ctx context.Context, method string, params ZabbixAPIParams, version int) ZabbixAPIParams {
logger := log.New().FromContext(ctx)
logger.Debug("performing query params migration", "method", method, "version", version)
switch method {
case "trigger.get":
newKey := "selectHostGroups"
deprecatedKey := "selectGroups"
deprecatedKeyValue, deprecatedKeyExists := params[deprecatedKey]
newKeyValue, newKeyExists := params[newKey]
if version < 70 && newKeyExists {
if deprecatedKeyExists {
delete(params, newKey)
}
if !deprecatedKeyExists {
params[deprecatedKey] = newKeyValue
delete(params, newKey)
}
}
if version >= 70 && deprecatedKeyExists {
if newKeyExists {
delete(params, deprecatedKey)
}
if !newKeyExists {
params[newKey] = deprecatedKeyValue
delete(params, deprecatedKey)
}
}
case "event.get":
newKey := "selectAcknowledges"
deprecatedKey := "select_acknowledges"
deprecatedKeyValue, deprecatedKeyExists := params[deprecatedKey]
newKeyValue, newKeyExists := params[newKey]
if version < 70 && newKeyExists {
if deprecatedKeyExists {
delete(params, newKey)
}
if !deprecatedKeyExists {
params[deprecatedKey] = newKeyValue
delete(params, newKey)
}
}
if version >= 70 && deprecatedKeyExists {
if newKeyExists {
delete(params, deprecatedKey)
}
if !newKeyExists {
params[newKey] = deprecatedKeyValue
delete(params, deprecatedKey)
}
}
case "hostgroup.get":
newKey := "with_hosts"
deprecatedKey := "real_hosts"
deprecatedKeyValue, deprecatedKeyExists := params[deprecatedKey]
newKeyValue, newKeyExists := params[newKey]
if version < 70 && newKeyExists {
if deprecatedKeyExists {
delete(params, newKey)
}
if !deprecatedKeyExists {
params[deprecatedKey] = newKeyValue
delete(params, newKey)
}
}
if version >= 70 && deprecatedKeyExists {
if newKeyExists {
delete(params, deprecatedKey)
}
if !newKeyExists {
params[newKey] = deprecatedKeyValue
delete(params, deprecatedKey)
}
}
}
return params
}

View File

@@ -92,7 +92,7 @@ func (api *ZabbixAPI) request(ctx context.Context, method string, params ZabbixA
"jsonrpc": "2.0", "jsonrpc": "2.0",
"id": 2, "id": 2,
"method": method, "method": method,
"params": params, "params": normalizeParams(ctx, method, params, version),
} }
// Zabbix v7.2 and later deprecated `auth` parameter and replaced it with using Auth header // Zabbix v7.2 and later deprecated `auth` parameter and replaced it with using Auth header

View File

@@ -9,6 +9,7 @@ import { APIExecuteScriptResponse, JSONRPCError, ZBXScript } from './types';
import { BackendSrvRequest, getBackendSrv } from '@grafana/runtime'; import { BackendSrvRequest, getBackendSrv } from '@grafana/runtime';
import { rangeUtil } from '@grafana/data'; import { rangeUtil } from '@grafana/data';
import { parseItemTag } from '../../../utils'; import { parseItemTag } from '../../../utils';
import { zabbixMethodName } from 'datasource/zabbix/types';
const DEFAULT_ZABBIX_VERSION = '3.0.0'; const DEFAULT_ZABBIX_VERSION = '3.0.0';
@@ -47,7 +48,7 @@ export class ZabbixAPIConnector {
// Core method wrappers // // Core method wrappers //
////////////////////////// //////////////////////////
request(method: string, params?: any) { request(method: zabbixMethodName, params?: any) {
if (!this.version) { if (!this.version) {
return this.initVersion().then(() => this.request(method, params)); return this.initVersion().then(() => this.request(method, params));
} }
@@ -55,7 +56,7 @@ export class ZabbixAPIConnector {
return this.backendAPIRequest(method, params); return this.backendAPIRequest(method, params);
} }
async backendAPIRequest(method: string, params: any = {}) { async backendAPIRequest(method: zabbixMethodName, params: any = {}) {
const requestOptions: BackendSrvRequest = { const requestOptions: BackendSrvRequest = {
url: this.backendAPIUrl, url: this.backendAPIUrl,
method: 'POST', method: 'POST',
@@ -142,15 +143,9 @@ export class ZabbixAPIConnector {
const params = { const params = {
output: ['name', 'groupid'], output: ['name', 'groupid'],
sortfield: 'name', sortfield: 'name',
[getParamsKeyByVersion('with_hosts', this.version, 'hostgroup.get')]: true,
}; };
// Zabbix v7.0 and later deprecated `real_hosts` parameter and replaced it with `with_hosts`
if (semver.gte(this.version, '7.0.0')) {
params['with_hosts'] = true;
} else {
params['real_hosts'] = true;
}
return this.request('hostgroup.get', params); return this.request('hostgroup.get', params);
} }
@@ -545,7 +540,7 @@ export class ZabbixAPIConnector {
expandExpression: true, expandExpression: true,
monitored: true, monitored: true,
skipDependent: true, skipDependent: true,
selectGroups: ['name', 'groupid'], [getParamsKeyByVersion('selectHostGroups', this.version, 'trigger.get')]: ['name', 'groupid'],
selectHosts: ['hostid', 'name', 'host', 'maintenance_status', 'description'], selectHosts: ['hostid', 'name', 'host', 'maintenance_status', 'description'],
selectItems: ['itemid', 'name', 'key_', 'lastvalue'], selectItems: ['itemid', 'name', 'key_', 'lastvalue'],
// selectLastEvent: 'extend', // selectLastEvent: 'extend',
@@ -580,7 +575,7 @@ export class ZabbixAPIConnector {
filter: { filter: {
value: 1, value: 1,
}, },
selectGroups: ['groupid', 'name'], [getParamsKeyByVersion('selectHostGroups', this.version, 'trigger.get')]: ['groupid', 'name'],
selectHosts: ['hostid', 'name', 'host', 'maintenance_status'], selectHosts: ['hostid', 'name', 'host', 'maintenance_status'],
selectItems: ['itemid', 'name', 'key_', 'lastvalue'], selectItems: ['itemid', 'name', 'key_', 'lastvalue'],
selectLastEvent: 'extend', selectLastEvent: 'extend',
@@ -619,9 +614,9 @@ export class ZabbixAPIConnector {
time_till: timeTo, time_till: timeTo,
objectids: objectids, objectids: objectids,
selectHosts: 'extend', selectHosts: 'extend',
[getParamsKeyByVersion('selectAcknowledges', this.version, 'event.get')]: 'extend',
value: showEvents, value: showEvents,
}; };
params[getSelectAcknowledgesKey(this.version)] = 'extend';
if (limit) { if (limit) {
params.limit = limit; params.limit = limit;
@@ -646,12 +641,12 @@ export class ZabbixAPIConnector {
sortfield: ['eventid'], sortfield: ['eventid'],
sortorder: 'DESC', sortorder: 'DESC',
selectTags: 'extend', selectTags: 'extend',
[getParamsKeyByVersion('selectAcknowledges', this.version, 'event.get')]: 'extend',
selectSuppressionData: ['maintenanceid', 'suppress_until'], selectSuppressionData: ['maintenanceid', 'suppress_until'],
groupids, groupids,
hostids, hostids,
applicationids, applicationids,
}; };
params[getSelectAcknowledgesKey(this.version)] = 'extend';
if (limit) { if (limit) {
params.limit = limit; params.limit = limit;
@@ -682,12 +677,11 @@ export class ZabbixAPIConnector {
eventids: eventids, eventids: eventids,
preservekeys: true, preservekeys: true,
selectTags: 'extend', selectTags: 'extend',
[getParamsKeyByVersion('selectAcknowledges', this.version, 'event.get')]: 'extend',
sortfield: 'clock', sortfield: 'clock',
sortorder: 'DESC', sortorder: 'DESC',
}; };
params[getSelectAcknowledgesKey(this.version)] = 'extend';
return this.request('event.get', params); return this.request('event.get', params);
} }
@@ -708,8 +702,8 @@ export class ZabbixAPIConnector {
preservekeys: true, preservekeys: true,
sortfield: 'clock', sortfield: 'clock',
sortorder: 'DESC', sortorder: 'DESC',
[getParamsKeyByVersion('selectAcknowledges', this.version, 'event.get')]: 'extend',
}; };
params[getSelectAcknowledgesKey(this.version)] = 'extend';
return this.request('event.get', params).then((events) => { return this.request('event.get', params).then((events) => {
return _.filter(events, (event) => event.acknowledges.length); return _.filter(events, (event) => event.acknowledges.length);
@@ -753,7 +747,7 @@ export class ZabbixAPIConnector {
monitored: true, monitored: true,
skipDependent: true, skipDependent: true,
selectLastEvent: 'extend', selectLastEvent: 'extend',
selectGroups: 'extend', [getParamsKeyByVersion('selectHostGroups', this.version, 'trigger.get')]: 'extend',
selectHosts: ['hostid', 'host', 'name'], selectHosts: ['hostid', 'host', 'name'],
}; };
@@ -801,7 +795,7 @@ export class ZabbixAPIConnector {
monitored: true, monitored: true,
skipDependent: true, skipDependent: true,
selectLastEvent: 'extend', selectLastEvent: 'extend',
selectGroups: 'extend', [getParamsKeyByVersion('selectHostGroups', this.version, 'trigger.get')]: 'extend',
selectHosts: ['host', 'name'], selectHosts: ['host', 'name'],
selectItems: ['name', 'key_'], selectItems: ['name', 'key_'],
}; };
@@ -851,7 +845,7 @@ export class ZabbixAPIConnector {
monitored: true, monitored: true,
skipDependent: true, skipDependent: true,
selectLastEvent: 'extend', selectLastEvent: 'extend',
selectGroups: 'extend', [getParamsKeyByVersion('selectHostGroups', this.version, 'trigger.get')]: 'extend',
selectHosts: ['host', 'name'], selectHosts: ['host', 'name'],
selectItems: ['name', 'key_'], selectItems: ['name', 'key_'],
}; };
@@ -984,6 +978,23 @@ export class ZabbixAPIError {
} }
} }
function getSelectAcknowledgesKey(version: string) { function getParamsKeyByVersion(
key: 'selectAcknowledges' | 'with_hosts' | 'selectHostGroups',
version: string,
event_name?: zabbixMethodName
): string {
if (!version) {
console.log(`Version not detected`, 'key', key, 'event_name', event_name);
version = '0.0.0';
}
switch (key) {
case 'selectHostGroups':
return semver.gte(version, '7.0.0') ? 'selectHostGroups' : 'selectGroups';
case 'selectAcknowledges':
return semver.gte(version, '7.0.0') ? 'selectAcknowledges' : 'select_acknowledges'; return semver.gte(version, '7.0.0') ? 'selectAcknowledges' : 'select_acknowledges';
case 'with_hosts':
return semver.gte(version, '7.0.0') ? 'with_hosts' : 'real_hosts';
default:
return '';
}
} }

View File

@@ -1,3 +1,27 @@
export type zabbixMethodName =
| 'alert.get'
| 'apiinfo.version'
| 'application.get'
| 'event.acknowledge'
| 'event.get'
| 'history.get'
| 'host.get'
| 'hostgroup.get'
| 'item.get'
| 'problem.get'
| 'proxy.get'
| 'script.execute'
| 'script.get'
| 'service.get'
| 'service.getsla'
| 'sla.get'
| 'sla.getsli'
| 'trend.get'
| 'trigger.get'
| 'user.get'
| 'usermacro.get'
| 'valuemap.get';
export interface ZabbixConnector { export interface ZabbixConnector {
getHistory: (items, timeFrom, timeTill) => Promise<any>; getHistory: (items, timeFrom, timeTill) => Promise<any>;
getTrend: (items, timeFrom, timeTill) => Promise<any>; getTrend: (items, timeFrom, timeTill) => Promise<any>;