Andreas Hilbig
b646b8c606
- Implement query optimization (reduced output, parameter skipping) to minimize Zabbix API traffic. - Add indirect dependency handling: deviceType implies tags and state implies items. - Move schema extensions to samples/extensions/ to clarify their role as samples. - Enhance DistanceTrackerDevice with String time fields to support optional date portions. - Ensure allDevices strictly filters by deviceType and populates the field in results. - Refactor runAllRegressionTests mutation to use internal unique names and improve stability. - Fix unnecessary Zabbix API calls for item preprocessing during template and host imports. - Update documentation including cookbook recipes, test specifications, and optimization guides. - Add extensive unit, integration, and regression tests covering all implemented changes. - Update docker-compose.yml to mount the samples/ directory as a volume. - Update IntelliJ .idea run configurations to reflect the new sample extension paths.
2.8 KiB
2.8 KiB
📊 Schema and Schema Extension
Main Schema Structure
The GraphQL schema is located in the ../../schema/ directory and consists of:
queries.graphql- Query definitions (see detailed documentation in file comments)mutations.graphql- Mutation definitions (see detailed documentation in file comments)devices.graphql- Device-related types (see detailed documentation in file comments)zabbix.graphql- Zabbix-specific types (see detailed documentation in file comments)device_value_commons.graphql- Common value types (see detailed documentation in file comments)api_commons.graphql- Common API types and permission system (see detailed documentation in file comments)samples/extensions/- Sample device type extensions (not part of the core source)
For comprehensive understanding of each operation, read the detailed comments in the respective schema files.
Zabbix to GraphQL Mapping
For a detailed mapping of Zabbix entities to GraphQL types, please refer to the Zabbix to GraphQL Mapping section in the main README.
Zabbix Entity Relationships
- Host Groups: Organize hosts and templates hierarchically; represented as
HostGroupobjects in GraphQL - Templates: Contain items and other configuration that can be applied to hosts; linked via template groups
- Items: Individual metrics collected from hosts; automatically mapped to nested GraphQL fields based on their key names
- Tags: Metadata associated with hosts/templates; used for classification and filtering
Location Type Usage
The Location type represents geographical information from Zabbix host inventory:
- Fields: Includes
name,location_lat,location_lon, and other inventory attributes - Usage: Available through the
locationsquery and as part of host/device objects - Access: Retrieved via the
getLocationsmethod in the Zabbix API datasource
Dynamic Schema Extension
Extend the schema without code changes using environment variables:
# Extensions can be located anywhere; samples are provided in samples/extensions/
ADDITIONAL_SCHEMAS=./samples/extensions/display_devices.graphql,./samples/extensions/location_tracker_devices.graphql
ADDITIONAL_RESOLVERS=SinglePanelDevice,FourPanelDevice,DistanceTrackerDevice
This enables runtime schema extension for custom device types without modifying the core code.
Sample Operations
For practical examples of schema usage, see the sample files in the ../queries/ directory:
../queries/sample_all_devices_query.graphql- Example of querying all devices../queries/sample_import_templates_mutation.graphql- Example of importing templates../queries/sample_import_host_groups_mutation.graphql- Example of importing host groups