Overview
Collected objects
Relationships
The addon establishes a structured relationship model in VVF & VCF Cloud Operations with the Adapter Instance as the root, an optional Organization layer, and child objects such as Groups and Monitors. Groups and Monitors can also attach directly to the Adapter when no assigned to Organization, enabling clear navigation, impact analysis, and faster issue resolution.
The Uptime Kuma addon defines a structured object model in VVF & VCF Cloud Operations to visualize and navigate service health from Uptime Kuma. The Adapter Instance is the root, followed by an optional Organization layer, and child objects representing Groups and Monitors. Both the Adapter Instance and each Monitor maintain a relationship to the corresponding Virtual Machine.
Uptime Kuma Organization is a logical tenant or workspace used to group related resources for access and reporting. This tab corresponds to the 'Status page' in Uptime Kuma.
Uptime Kuma Group is aggregating the state of child monitors and aiding navigation without enforcing dependencies.
Uptime Kuma Monitor is an individual check (HTTP, TCP, Ping, etc.) exposing properties and metrics mapped from Uptime Kuma for dashboards and alerting.
The primary and preferred relationship path is:
Uptime Kuma Adapter Instance→Uptime Kuma Organization→Uptime Kuma Group/Monitor.
If a Group or Monitor does not belong to any Organization, it links directly under the Adapter Instance:
Uptime Kuma Adapter Instance→Uptime Kuma Group/Monitor.
VM relationship via tag
In addition to the default IP-based relationship resolution, a Monitor can be explicitly linked to one or more Virtual Machines using a tag defined in Uptime Kuma.
To create a relationship, add the following tag to the Monitor: System Name: <vm-name-or-ip>.
Multiple values can be provided, separated by commas, for example: System Name: vm-prod-01, vm-prod-02, 10.10.10.15.
If the System Name tag is not provided, the adapter falls back to automatic IP-based relationship resolution.
If one or more referenced systems cannot be found, a warning event is generated listing all unresolved values.
Uptime Kuma Organization
Identifiers
| Name | Description |
|---|---|
| ID | Component ID |
Properties & Metrics
| Name | Type | Description |
|---|---|---|
| Name | Property | Component name |
| Description | Property | Component description |
Uptime Kuma Group & Uptime Kuma Monitor
Identifiers
| Name | Description |
|---|---|
| ID | Component ID |
Properties & Metrics
| Name | Type | Description |
|---|---|---|
| Name | Property | Component name |
| Description | Property | Component description |
| Authentication Method | Property | Component authentication method |
| Method | Property | HTTP Method |
| Certificate Expiration Date | Property | Date when the SSL certificate of Component will expire |
| Certificate Valid | Property | Specifies if SSL certificate is still valid |
| Certificate Days Remaining | Property | Number of days left until SSL certificate expires |
| Status | Metric | Component status (1 = UP, 0 = DOWN, 2 = PENDING, 3 = MAINTENANCE) |
| Response Time | Metric | Component response time |
| Tag | Group | Tags assigned to the Component |
| Uptime | Group | Percentage value of 24 hour, 30 days and 1 year Component Uptime |
Tag
| Name | Type | Description |
|---|---|---|
| Name | Property | Tag name |
| Value | Property | Tag value |
Uptime
| Name | Type | Description |
|---|---|---|
| Value | Metric | Percentage Uptime value for selected period of time |