zabbix/zabbix-graphql-api
1
0
Fork 0
Code Pull requests Activity

feat: README enhancement

Browse source
This commit is contained in:
Vladimir Svacko 2026-01-28 16:45:46 +01:00
parent b7c56d11f2
commit 40c6bed639
2 changed files with 31 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -308,6 +308,35 @@ The GraphQL schema is located in the `schema/` directory and consists of:
For comprehensive understanding of each operation, read the detailed comments in the respective schema files.
### Zabbix to GraphQL Mapping
The API maps Zabbix entities to GraphQL types as follows:
| Zabbix Entity | GraphQL Type | Description |
|---------------|--------------|-------------|
| Host | `Host` / `Device` | Represents a Zabbix host; `Device` is a specialized `Host` with a `deviceType` tag |
| Host Group | `HostGroup` | Represents a Zabbix host group |
| Template | `Template` | Represents a Zabbix template |
| Template Group | `HostGroup` | Represents a Zabbix template group |
| Item | Nested fields in `Device` | Zabbix items become nested fields in the device based on their key names |
| Tag | `Tag` | Represents a Zabbix tag associated with a host or template |
| Inventory | `Location` | Host inventory information maps to location data |
### Zabbix Entity Relationships
- **Host Groups**: Organize hosts and templates hierarchically; represented as `HostGroup` objects 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 `locations` query and as part of host/device objects
- **Access**: Retrieved via the `getLocations` method in the Zabbix API datasource
### Dynamic Schema Extension
Extend the schema without code changes using environment variables:
@ -383,6 +412,8 @@ The comments in these files contain real-world usage examples, implementation no
### Zabbix-Side Configuration
Before extending the schema, you need to configure Zabbix appropriately:
#### 0. Template Group configuration
- Create a template group `Templates/Roadwork/Devices`
#### 1. Host Configuration in Zabbix
- Create a host in Zabbix with the tag `deviceType` set to `distance-tracker`