This commit comprehensive updates the API to ensure full compatibility across all major Zabbix versions (6.0 LTS, 6.2, 6.4, and 7.0 LTS) and introduces a local development environment for multi-version testing.
Verified Zabbix Versions:
- Zabbix 7.0 (LTS): Full support, including native `history.push` for telemetry.
- Zabbix 6.4: Supported (excluding `history.push`); uses `hostgroup.propagate` and UUID-based matching.
- Zabbix 6.2: Supported (excluding `history.push`); uses `hostgroup.propagate` and `templategroup.*` methods.
- Zabbix 6.0 (LTS): Supported (excluding `history.push`); includes specific fallbacks:
- JSON-RPC: Restored `auth` field in request body for versions lacking Bearer token support.
- Permissions: Implemented name-based fallback for host/template groups (no UUIDs in 6.0).
- Group Expansion: Automatic manual expansion of group rights during import.
- API Methods: Fallback from `templategroup.*` to `hostgroup.*` methods.
Key Technical Changes:
- Local Development: Added `zabbix-local` Docker Compose profile to launch a complete Zabbix stack (Server, Web, Postgres) from scratch with dynamic versioning via `ZABBIX_VERSION`.
- Query Optimization: Refined dynamic field selection to handle implied fields and ensure consistent output regardless of initial Zabbix parameters.
- Documentation:
- New `local_development.md` HOWTO guide.
- Updated `README.md` with detailed version compatibility matrix.
- Expanded `roadmap.md` with achieved milestones.
- Testing:
- Updated entire Jest test suite (23 suites, 96 tests) to be version-aware and robust against naming collisions.
- Enhanced Smoketest and Regression Test executors with better cleanup and error reporting.
3 KiB
🗺️ Roadmap
This document outlines the achieved milestones and planned enhancements for the Zabbix GraphQL API project.
✅ Achieved Milestones
-
🎯 VCR Product Integration: Developed a specialized GraphQL API as part of the VCR Product to enable the use of Zabbix as a robust base for monitoring and controlling IoT devices.
- First use case: Control of mobile traffic jam warning installations on German Autobahns.
-
⚡ Query Optimization: Optimized GraphQL API queries to reduce the amount of data fetched from Zabbix depending on the fields really requested.
- Implementation: Added dynamic output selection and field pruning in
ZabbixRequest.
- Implementation: Added dynamic output selection and field pruning in
-
🔓 Open Source Extraction & AI Integration: Extracted the core functionality of the API to publish it as an Open Source project.
- AI Integration: Enhanced with Model Context Protocol (MCP) and AI agent integration to enable workflow and agent-supported use cases.
-
🐳 Local Development Environment: Integrated a complete Zabbix stack into the Docker Compose configuration using profiles.
- Feature: Support for multiple Zabbix versions (6.0, 6.4, 7.0+) for development and testing.
- Implementation: Added
zabbix-localprofile andZABBIX_VERSIONdynamic image tagging.
-
🔧 Multi-Version Compatibility: Verified and enhanced support for Zabbix 6.0 LTS, 6.2, 6.4, and 7.0 LTS.
- Feature: Automatic fallback logic for older Zabbix versions (auth, name-based matching, manual expansion).
- Verification: Full regression and smoketest suites passed across all mentioned versions.
📅 Planned Enhancements
-
🏗️ Trade Fair Logistics Use Case: Extend the API to support trade fair logistics use cases by analyzing requirements from business stakeholders.
- Analysis: Analysis of "Trade Fair Logistics" and derived requirements document.
- Simulation:
- Create mocked "real world sensor devices" relevant for the use case.
- Create a sample device collecting relevant information from public APIs, e.g. weather conditions or traffic conditions at a given location.
- Simulate the traffic conditions on the route by using the simulated sensor devices.
- Configuration: Analyze a real-world transport and configure Zabbix by placing sensor devices at the right places of the route.
-
📦 CI/CD & Package Publishing: Build and publish the API as an npm package as part of the
.forgejoworkflow to simplify distribution and updates. -
🧱 Flexible Usage: Transform the package into a versatile tool that can be used either standalone or as a core library (published to npmjs.com).
-
🧩 Extension Project: Add support for problem and trigger-related queries through the
zabbix-graphql-api-problemsextension.- AI Integration: Leverage MCP + AI agents to automatically react to Zabbix problems within external workflows.