Zabbix 5.0.x supported filtering `Problems` feature with `applications`.
When this got removed, we removed the filter dropdown from the UI, but
failed to check whether applications were supported before sending out
the request with the parameters.
This was causing dashboards that had been created with zabbix version
`5.0.x` to fail when querying with newer versions of our plugin with
error: `Invalid params. Invalid parameter "/": unexpected parameter
"applicationids".`
These changes now ensure that we also check whether applications filter
should be supported before sending the backend request to fetch
problems.
How to test:
- use the attached JSON file. This was created using zabbix50 and
applying an `applicationids` filter for `Problems` query type OR
- run the `zabbix50` test environment:
```
cd devenv/zabbix50
docker-compose up -d
```
- create a dashboard that queries for `Problems` and filters with
applications then export the dashboard JSON
- stop the `zabbix50` test environment and start the `zabbix74` test
environment
```
docker-compose stop
cd ../zabbix74
docker-compose up -d
```
- import the dashboard you created above, it should load and work as
expected.
Bottom panel was created using zabbix50 and it used the application
filter. Both panels now load as expected:
<img width="2558" height="1018" alt="Screenshot 2025-10-21 at 2 28
25 PM"
src="https://github.com/user-attachments/assets/9613d59b-3f88-420c-9897-f8d988b3d2f0"
/>
Fixes https://github.com/grafana/grafana-zabbix/issues/1852
158 lines
5.5 KiB
TypeScript
158 lines
5.5 KiB
TypeScript
import { Zabbix } from './zabbix';
|
|
import { joinTriggersWithEvents } from '../problemsHandler';
|
|
|
|
jest.mock('../problemsHandler', () => ({
|
|
joinTriggersWithEvents: jest.fn(),
|
|
joinTriggersWithProblems: jest.fn(),
|
|
}));
|
|
|
|
jest.mock(
|
|
'@grafana/runtime',
|
|
() => ({
|
|
getBackendSrv: () => ({
|
|
datasourceRequest: jest.fn().mockResolvedValue({ data: { result: '' } }),
|
|
fetch: () => ({
|
|
toPromise: () => jest.fn().mockResolvedValue({ data: { result: '' } }),
|
|
}),
|
|
}),
|
|
}),
|
|
{ virtual: true }
|
|
);
|
|
|
|
describe('Zabbix', () => {
|
|
let consoleSpy: jest.SpyInstance;
|
|
let ctx = {
|
|
options: {
|
|
url: 'http://localhost',
|
|
username: 'zabbix',
|
|
password: 'zabbix',
|
|
},
|
|
};
|
|
let zabbix;
|
|
|
|
beforeEach(() => {
|
|
zabbix = new Zabbix(ctx.options);
|
|
consoleSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
|
|
});
|
|
|
|
afterEach(() => {
|
|
consoleSpy.mockRestore();
|
|
});
|
|
|
|
describe('When querying proxies', () => {
|
|
beforeEach(() => {
|
|
zabbix.zabbixAPI.getProxies = jest.fn().mockResolvedValue([
|
|
{ host: 'proxy-foo', proxyid: '10101' },
|
|
{ host: 'proxy-bar', proxyid: '10102' },
|
|
]);
|
|
});
|
|
|
|
it('should return all proxies if filter set to /.*/', (done) => {
|
|
zabbix.getFilteredProxies('/.*/').then((proxies) => {
|
|
expect(proxies).toMatchObject([{ host: 'proxy-foo' }, { host: 'proxy-bar' }]);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should return matched proxies if regex filter used', (done) => {
|
|
zabbix.getFilteredProxies('/.*-foo/').then((proxies) => {
|
|
expect(proxies).toMatchObject([{ host: 'proxy-foo' }]);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should return matched proxies if simple filter used', (done) => {
|
|
zabbix.getFilteredProxies('proxy-bar').then((proxies) => {
|
|
expect(proxies).toMatchObject([{ host: 'proxy-bar' }]);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should return empty list for empty filter', (done) => {
|
|
zabbix.getFilteredProxies('').then((proxies) => {
|
|
expect(proxies).toEqual([]);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('When filtering triggers by proxy', () => {
|
|
const triggers = [
|
|
{ triggerid: '1', hosts: [{ name: 'backend01', proxy_hostid: '0' }] },
|
|
{ triggerid: '2', hosts: [{ name: 'backend02', proxy_hostid: '0' }] },
|
|
{ triggerid: '3', hosts: [{ name: 'frontend01', proxy_hostid: '10101' }] },
|
|
{ triggerid: '4', hosts: [{ name: 'frontend02', proxy_hostid: '10101' }] },
|
|
{ triggerid: '5', hosts: [{ name: 'db01', proxy_hostid: '10102' }] },
|
|
{ triggerid: '6', hosts: [{ name: 'db02', proxy_hostid: '10102' }] },
|
|
];
|
|
beforeEach(() => {
|
|
zabbix.zabbixAPI.getProxies = jest.fn().mockResolvedValue([
|
|
{ host: 'proxy-foo', proxyid: '10101' },
|
|
{ host: 'proxy-bar', proxyid: '10102' },
|
|
]);
|
|
});
|
|
|
|
it('should return all triggers for empty filter', (done) => {
|
|
zabbix.filterTriggersByProxy(triggers, '').then((triggers) => {
|
|
const triggerids = triggers.map((t) => t.triggerid);
|
|
expect(triggerids).toEqual(['1', '2', '3', '4', '5', '6']);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should return triggers belonging proxy matched regex filter', (done) => {
|
|
zabbix.filterTriggersByProxy(triggers, '/.*-foo/').then((triggers) => {
|
|
const triggerids = triggers.map((t) => t.triggerid);
|
|
expect(triggerids).toEqual(['3', '4']);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should return triggers belonging proxy matched name filter', (done) => {
|
|
zabbix.filterTriggersByProxy(triggers, 'proxy-bar').then((triggers) => {
|
|
const triggerids = triggers.map((t) => t.triggerid);
|
|
expect(triggerids).toEqual(['5', '6']);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('getProblemsHistory', () => {
|
|
const ctx = { url: 'http://localhost' };
|
|
let zabbix: Zabbix;
|
|
|
|
beforeEach(() => {
|
|
zabbix = new Zabbix(ctx);
|
|
zabbix.getGroups = jest.fn().mockResolvedValue([{ groupid: '21' }]);
|
|
zabbix.getHosts = jest.fn().mockResolvedValue([{ hostid: '31' }]);
|
|
zabbix.getApps = jest.fn().mockResolvedValue([{ applicationid: '41' }]);
|
|
zabbix.supportsApplications = jest.fn().mockReturnValue(true);
|
|
zabbix.zabbixAPI.getEventsHistory = jest.fn().mockResolvedValue([{ objectid: '501' }]);
|
|
zabbix.zabbixAPI.getTriggersByIds = jest.fn().mockResolvedValue([{ triggerid: '501' }]);
|
|
(joinTriggersWithEvents as jest.Mock).mockReturnValue([{ triggerid: '501' }]);
|
|
zabbix.filterTriggersByProxy = jest.fn().mockResolvedValue([{ triggerid: '501' }]);
|
|
});
|
|
|
|
it('builds the history query and returns filtered triggers', async () => {
|
|
const result = await zabbix.getProblemsHistory('group.*', 'host.*', 'app.*', 'proxy-foo', {
|
|
valueFromEvent: true,
|
|
});
|
|
|
|
expect(zabbix.zabbixAPI.getEventsHistory).toHaveBeenCalledWith(['21'], ['31'], ['41'], { valueFromEvent: true });
|
|
expect(joinTriggersWithEvents).toHaveBeenCalledWith([{ objectid: '501' }], [{ triggerid: '501' }], {
|
|
valueFromEvent: true,
|
|
});
|
|
expect(zabbix.filterTriggersByProxy).toHaveBeenCalledWith([{ triggerid: '501' }], 'proxy-foo');
|
|
expect(result).toEqual([{ triggerid: '501' }]);
|
|
});
|
|
|
|
it('omits applicationids when applications are unsupported', async () => {
|
|
(zabbix.supportsApplications as jest.Mock).mockReturnValue(false);
|
|
|
|
await zabbix.getProblemsHistory('group.*', 'host.*', 'app.*', undefined, {});
|
|
|
|
expect(zabbix.zabbixAPI.getEventsHistory).toHaveBeenCalledWith(['21'], ['31'], undefined, {});
|
|
});
|
|
});
|
|
});
|