zabbix/zabbix-graphql-api
1
0
Fork 0
Code Pull requests Activity
zabbix-graphql-api/roadmap.md
Andreas Hilbig fb5e9cbe81 feat: improve Zabbix multi-version compatibility and introduce local development environment 
This update enhances compatibility across multiple Zabbix versions and introduces tools for easier local development and testing.

Key improvements and verified version support:
- Verified Zabbix version support: 6.2, 6.4, 7.0, and 7.4.
- Version-specific feature handling:
  - `history.push` is enabled only for Zabbix 7.0+; older versions skip it with a clear error or notice.
  - Conditional JSON-RPC authentication: the `auth` field is automatically added to the request body for versions older than 6.4.
  - Implemented static Zabbix version caching in the datasource to minimize redundant API calls.
- Query optimization refinements:
  - Added mapping for implied fields (e.g., `state` -> `items`, `deviceType` -> `tags`).
  - Automatically prune unnecessary Zabbix parameters (like `selectItems` or `selectTags`) when not requested.
- Local development environment:
  - Added a new `zabbix-local` Docker Compose profile that includes PostgreSQL, Zabbix Server, and Zabbix Web.
  - Supports testing different versions by passing the `ZABBIX_VERSION` environment variable (e.g., 6.2, 6.4, 7.0, 7.4).
  - Provided a sample environment file at `samples/zabbix-local.env`.
- Documentation and Roadmap:
  - Updated README with a comprehensive version compatibility matrix and local environment instructions.
  - Created a new guide: `docs/howtos/local_development.md`.
  - Updated maintenance guides and added "Local Development Environment" as an achieved milestone in the roadmap.
- Test suite enhancements:
  - Improved Smoketest and RegressionTest executors with more reliable resource cleanup and error reporting.
  - Made tests version-aware to prevent failures on older Zabbix instances.

BREAKING CHANGE: Dropped Zabbix 6.0 specific workarounds; the minimum supported version is now 6.2.
2026-02-04 14:01:53 +01:00

3 KiB
Raw Blame History

🗺️ 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.

  • 🔓 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.2, 6.4, 7.0+) for development and testing.
    • Implementation: Added zabbix-local profile and ZABBIX_VERSION dynamic image tagging.

  • 🔧 Multi-Version Compatibility: Verified and enhanced support for Zabbix 6.2, 6.4, and 7.0 LTS.

    • Feature: Native support for separate template groups and automated permission propagation.
    • Verification: Full regression and smoketest suites passed across all mentioned versions. Support for Zabbix 6.0 was deprecated due to excessive API differences and required fallbacks.

📅 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 .forgejo workflow 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-problems extension.

    • AI Integration: Leverage MCP + AI agents to automatically react to Zabbix problems within external workflows.