Entity Type Management¶

This document describes how to customize entity types and extend the asset management capabilities of the Resource Catalog.

Go to Resource Catalog > Entity List, click the "Settings" icon in the left sidebar, and select "Manage Entity Types" to access the entity type management page.

Create Entity Type¶

1. Click "Create Entity Type" in the upper right corner of the entity type management page.
2. Fill in the basic information:
   • Entity Type: A globally unique identifier, e.g., kubernetes_deployment.
   • Display Name: Enter the display name of the entity type.
   • Description: Optionally add a description of the type's purpose.
3. Expand the "Advanced Configuration (Optional)" section to customize the Data Schema, display columns, and related views via YAML.
4. Click "Save" to complete the creation.

Advanced Configuration (Optional)¶

When creating or editing an entity type, the "Advanced Configuration (Optional)" section is displayed below the basic information. The system will generate the following configuration based on a default template. You can use the default configuration or edit the YAML as needed.

Data Schema Configuration¶

Define the fields, sources, required fields, and validation rules for the entity type. By default, a YAML preview is generated based on the system's default DataSchema template.

• Official Entity Types: Based on dataschema.yaml, with support for appending custom_properties.
• Custom Entity Types: Based on the Resource Catalog default template, with support for custom fields, sources, required fields, enums, default values, and validation rules.

Click to view the Data Schema Configuration Guide.

Default Display Column Configuration¶

Used to configure fixed columns, default columns, and optional columns in the entity list.

Configuration rules:

• field: The field name.
• fixed: Whether it is a fixed display column. Default is false. Fixed columns are always displayed and do not appear in the enable/disable list for display columns.
• hidden: Whether it is hidden by default. Default is false. false means it is displayed by default; true means it is not displayed by default but can be enabled in the display column configuration.
• Shorthand forms such as name and entity_type are equivalent to field: name and field: entity_type, and are displayed by default.
• User personal column preferences take precedence over the type's default configuration.

Click to view the Default Display Column Configuration Guide.

Related View Configuration¶

Configure the related views on the entity details page.

• For official configurations, built-in related views can be enabled or disabled via YAML.
• Custom related views can be added via YAML.
• For log-related views, if you need to configure a default index, use the index field in YAML. Multiple indexes should be in array format.

Configuration example:

telemetry:
  - name: { zh-CN: "Error Logs", en-US: "Error Logs" }
    type: explorer
    viewName: logs
    index: ["app-prod", "gateway-prod"]
    query: "service='{{metadata.service}}' AND df_status NOT IN ['ok','info']"

Click to view the Related View Configuration Guide.

Entity Type List¶

The entity type list page displays all entity types in the current workspace, including system-preset, official built-in, and custom types. The list shows the display name, entity type identifier, description, number of entities, and classification tags for each type.

Type Categories¶

Health Configuration¶

Only the system type supports health configuration, which is used to set a default health calculation method for all entities under that system type.

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

What is System Health¶

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

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

Health Status Description¶

System health is divided into four states:

Default Algorithm Description¶

The default algorithm calculates based on a three-step aggregation:

1. Determine Constituent Entities and Their Importance

System health is calculated based on its constituent entities (e.g., services, hosts, databases). Different entities have different levels of impact on the system:

• Each entity has a base importance level. Higher-level entities have a greater impact on system health.
• You can also adjust the health impact weight of a constituent entity in the system, overriding the default level.
• If an entity is set to "Not Participate in Calculation", its alerts will not affect system health.

2. Evaluate the Alert Impact of Individual Entities

When a constituent entity has unresolved alerts, the platform deducts points based on the severity of the alert:

When multiple active alerts exist on the same entity, the platform takes the top 3 most impactful active faults and applies a decreasing coefficient (the first at full value, the second at 50%, the third at 25%). This prevents scores from being distorted by a large number of low-level alerts while also not underestimating the risk of concurrent faults.

3. Calculate the Weighted System Score and Determine the Status

The system score is calculated using a weighted average method:

• Multiply the alert deduction of each constituent entity by its importance weight.
• Sum the weighted deductions of all constituent entities, then divide by the total weight.
• Subtract the weighted average deduction from 100 to get the final system score.

Status Determination:

Custom Function¶

Entity Status Determination¶

Entity status reflects the reporting activity of the data source. It is automatically determined by the system based on the last reported time and does not require manual maintenance. Currently, it supports hosts (based on DataKit data reporting) and services (based on APM span data reporting).

Configure Determination Rules¶

Go to Resource Catalog > Manage Entity Types > Entity List, click the "Settings" icon in the left sidebar, and select "Manage Entity Types". In the entity type list, click "Set Determination Rules" at the end of the host or service type row.

View Entity Status¶

1. Entity List

You can filter by "All / Online / Offline" using the "Entity Status" column.

2. Entity Details Page

A status tag is displayed at the top. For offline entities, you can view the offline time, estimated removal time, and last reported time, and manually activate them.

3. Full Topology Map

Supports one-click display of only online entities.

Manage Related Views¶

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

Built-in Related Views¶

These are the default related views provided by the system. You can enable or disable them as needed.

• If the current entity type has official built-in views, they will be listed automatically on the page and are enabled by default.
• Enable/Disable: Allows you to customize whether the current view is displayed.

After disabling, the view will no longer be displayed on the entity details page.

Custom Related Views¶

Supports custom configuration of related views according to the 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 the Configuration Details.

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