Andreas Hilbig
fb5e9cbe81
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. |
||
|---|---|---|
| .. | ||
| cookbook.md | ||
| hierarchical_data_mapping.md | ||
| local_development.md | ||
| maintenance.md | ||
| mcp.md | ||
| permissions.md | ||
| query_optimization.md | ||
| README.md | ||
| schema.md | ||
| tags.md | ||
How-To Guides
This directory contains detailed guides on how to use and extend the Zabbix GraphQL API.
Available Guides
🍳 Cookbook
Practical, step-by-step recipes for common tasks, designed for both humans and AI-based test generation.
⚡ Query Optimization
Learn how the API optimizes Zabbix requests by reducing output fields and skipping unnecessary parameters based on the GraphQL query.
📊 Schema and Schema Extension
Learn about the GraphQL schema structure, how Zabbix entities map to GraphQL types, and how to use the dynamic schema extension system.
🗂️ Hierarchical Data Mapping
Understand how the API automatically maps flat Zabbix item keys into nested GraphQL objects using hierarchical resolvers and type hinting.
🔐 Roles and Permissions Extension
Discover how the permission system works, how to define permission levels using Zabbix template groups, and how to query user permissions.
🛠️ Technical Maintenance
Guide on code generation (GraphQL Codegen), running Jest tests, and local Docker builds.
💻 Local Development Environment
Detailed instructions for setting up a fully isolated local development environment with Zabbix using Docker Compose.
🧪 Test Specification
Detailed list of test cases, categories (Unit, Integration, E2E), and coverage checklist.
🤖 MCP & Agent Integration
Discover how to integrate with the Model Context Protocol (MCP) to enable LLMs and autonomous agents to interact with Zabbix efficiently.
🔍 Additional Resources
- Sample Queries: Categorized list of practical GraphQL operation examples.
- Main README: Technical reference, configuration, and environment setup.