Entity Type Management¶

This document describes how to customize entity types to extend the asset management capabilities of the unified catalog.

Create Entity Type¶

Go to Unified Catalog > Entity List.
Click the "Settings" icon on the left sidebar and select "Manage Entity Types".
Click "Create Entity Type" in the upper right corner of the pop-up window.
Fill in the configuration information:
- Entity Type: A globally unique identifier, such as kubernetes_deployment.
- Display Name: Enter the display name for the entity type.
- Description: Optionally add a description of the type's purpose.
Click "Save" to complete the creation.

Note

Entity type identifiers must be unique. If a duplicate exists, the system will display an error.
Before deleting a type, ensure no entities are associated with it. Otherwise, deletion is not possible.

Manage Existing Types¶

In the "Manage Entity Types" pop-up window, you can view all entity types within the current workspace, including system-preset and custom types.

Type Categories¶

The list displays the display name, entity type identifier, description, entity count, and classification label for each type.

Category	Included Types	Operation Permissions
System-preset	System, Service, Host, Database, Queue	Only supports "Manage Entity Views". Editing or deletion is not allowed.
Custom	User-created types (e.g., K8s resources, business domains)	Supports editing, deletion, and managing entity views.

Health Configuration¶

Only the system type supports health configuration. This is used to uniformly set the default health calculation method for all entities of this system type.

Click "Health Configuration" in the operation menu for the system type row and choose one of the following two methods:

Method	Description
Default Algorithm	Uses the built-in aggregation algorithm described above to calculate health.
Custom Function	Calls a Func platform function to calculate health. After selecting this, you need to specify the specific Func function.

Effective Rules

The configuration here serves as the default rule for this system type and applies to all system entities.
When creating or editing a specific system entity, you can choose to follow the default configuration or specify a custom function individually. Entities with individual specifications are not affected by changes to the configuration here.
If the custom function configured here is deleted or becomes unavailable, the health status of entities following the default configuration will display as "Unknown". Entities with individual specifications are not affected.

What is System Health?¶

A System (system) is a user-defined business aggregation entity representing a business system or platform collection (e.g., "Payment System", "Order System"). Since alerts/incidents are typically associated with its underlying entities like services, hosts, and databases, rather than directly with the system itself, system health is calculated by aggregating the unresolved alert statuses of its component entities.

Simply put: System health reflects how well "the various parts that make up this system" are running overall.

Health Status Description¶

System health is divided into four states:

Status	Score Range	Meaning	Common Scenarios
Healthy	80–100	Component entities are running well overall with no unresolved alerts.	All component entities have no active alerts.
Attention	60–79	Component entities have anomalies requiring attention.	Some entities have warning or error level alerts.
Critical	0–59	Component entities have severe anomalies, suggesting immediate action.	Core entities have fatal/critical alerts, or multiple entities are failing simultaneously.
Unknown	—	Health cannot be calculated temporarily.	The system currently has no component entities, or the first calculation hasn't completed after system creation.

Default Algorithm Description¶

The default algorithm calculates based on the following three-step aggregation:

1. Determine Component Entities and Their Importance System health is calculated based on its component entities (e.g., services, hosts, databases). Different entities have varying impact on system health: * Each entity has a base importance level. Entities with higher levels have a greater impact on system health. * You can also adjust the Health Impact Weight for a component entity within the system, overriding its default level. * If an entity is set to "Do not participate in calculation", its alerts do not affect system health.

2. Assess the Alert Impact of Individual Entities When a component entity has unresolved alerts, the platform deducts points based on the alert severity:

Alert Severity	Impact on Entity
fatal / critical	Severe point deduction
error	Moderate point deduction
warning	Minor point deduction
info / recovered	No point deduction

When the same entity has multiple active alerts simultaneously, the platform takes the top 3 active faults with the greatest impact and applies a diminishing coefficient (100% for the 1st, 50% for the 2nd, 25% for the 3rd). This avoids score distortion from numerous low-level alerts while not underestimating the risk of concurrent multiple faults.

3. Calculate Weighted System Total Score and Determine Status The system score is calculated using a weighted average: * Multiply the alert deduction points of each component entity by its importance weight. * Sum the weighted deduction points of all component entities, then divide by the total weight. * Subtract the above weighted average deduction from 100 points to get the final system score.

Status Determination:

Score Range	Status
80–100	Healthy
60–79	Attention
0–59	Critical

Custom Function¶

Customize Health Function via Func

Manage Correlation Views¶

Click the icon on the right side of a single entity row to enter the "Manage Correlation Views" page. The page is divided into two areas: Built-in Correlation Views and Custom Correlation Views.

Built-in Correlation Views¶

Correlation views provided by the system by default, which can be enabled or disabled as needed. * If official built-in views exist for the current entity type, they will be automatically listed on the page and are enabled by default. * Enable/Disable: You can customize whether to show or hide the current view.

After disabling, the view will no longer be displayed on the Entity Details page.

Custom Correlation Views¶

Supports custom configuration of correlation views according to a specified format.

After configuration, all entities of this type will display the corresponding tab on the details page, facilitating quick drill-down analysis.

Click to view Configuration Details.