Create Entity Objects¶

Go to Resource Catalog > Entity List, click the "Add" button in the upper right corner, or click the settings icon on the left and select "Create Entity Object" to open the "Create Entity Object" dialog.

Note

Configuration items vary for different entity types. Please ensure you select the correct type before filling in the configuration information.

Basic Information¶

Select the entity type to add, including: System, Service, Host, Database, etc.
Define the name of the current entity.

Configuration Information¶

In the "Configuration Information" area, you can configure entity attributes via the "Editor" or "YAML" modes. Click the tabs in the upper right corner to switch.

Editor Mode¶

1. Basic Information¶

Field	Description
Display Name	The display name of the entity in the list. If filled, it will be displayed in preference to the system name.
Description	Detailed description of the entity.
Project	The project to which the entity type (System/Service/Host/Database, etc.) belongs.
Resource ID (ARN)	Required when creating a new cloud resource. It is the globally unique identifier for the cloud resource.

2. System¶

SystemServiceHostDatabaseCloud Provider

Field	Description
System Type	Select the system type to which the entity belongs, including Business Application, Shared Service, MIDDLEWARE Platform, Data Platform, Internal Tool.
Lifecycle	Select the current lifecycle stage of the system, including Planning, Under Construction, In Operation, Under Maintenance, Deactivated, Decommissioned.
Environment	Select the deployment environment, including Production, Staging, Testing, Development.
Importance Level	Select the level, including Core, Important, Normal, Low, Test.

Field	Description
Service Type	Select the service type to which the entity belongs, including Web, DB, Cache, Queue, etc.
Service Language	Select the language of the current service, including Java, go, Python, etc.
Lifecycle	Select the current lifecycle stage of the service, including Planning, Under Construction, In Operation, Under Maintenance, Deactivated, Decommissioned.
Environment	Select the deployment environment, including Production, Staging, Testing, Development.

Field	Description
Host IP	Enter the host IP address.
Operating System	Select the operating system of the current entity, including Linux, Windows, macoS.
Lifecycle	Select the current lifecycle stage of the host, including Planning, Under Construction, In Operation, Under Maintenance, Deactivated, Decommissioned.
Environment	Select the deployment environment, including Production, Staging, Testing, Development.
Cloud Provider	Select the cloud service provider to which the entity belongs.
Instance ID	Select the instance ID to which the entity belongs.
Region	Select the region to which the entity belongs, e.g., `cn-hangzhou`.
Availability Zone	Select the availability zone of the entity, e.g., `cn-hangzhou-q`.

Field	Description
Database Type	Select the database type, such as MySQL, PostgreSQL, MongoDB, Oracle, SQLServer, etc.
Version	Enter the version number.
Host Address	Enter the host address.
Port	Define the host port.
Service Address	Define the service address, e.g., 10.0.0.12:3306. Used to associate with the `server` tag in official collectors. The format is `host:port`.
Region	Select the region to which the entity belongs, e.g., `cn-shenzhen`.
Availability Zone	Select the availability zone of the entity, e.g., `cn-shenzhen-e`.
Environment	Select the deployment environment, including Production, Staging, Testing, Development.
Lifecycle	Select the current lifecycle stage of the database, including Planning, Under Construction, In Operation, Under Maintenance, Deactivated, Decommissioned.
Importance Level	Select the level, including Core, Important, Normal, Low, Test.

Field	Description
Cloud Provider	Select the cloud service provider, such as Alibaba Cloud, AWS, Tencent Cloud, Huawei Cloud, Azure, etc.
Cloud Account	Enter the cloud account for the current entity.
Resource Type	Select the resource type, such as `aws_s3_bucket`.
Region	Select the region to which the entity belongs, e.g., `cn-shenzhen`.
Availability Zone	Select the availability zone of the entity, e.g., `cn-shenzhen-e`.
Resource Attributes	Click the "Add" button and fill in `key:value` pairs.

3. Relationships¶

Field	Description
Health Configuration	Select the health calculation method for this system. Health reflects the overall operational status of a system. It is automatically aggregated and calculated by the platform based on the unresolved alerts of its component entities (services, hosts, databases, etc.), and is divided into four states: Healthy: The component entities are generally running well, with no unresolved alerts. Attention: There are anomalies in the component entities that require attention. Critical: There are critical anomalies in the component entities, and immediate action is recommended. Unknown: The system currently has no component entities, or the health calculation failed. Two calculation methods are supported: Inherit System Type: Use the default algorithm configured in the system type. Custom: Call a Func platform function to calculate the health of this system individually. After selecting this, you need to specify the specific function.
Component Entities	The services, hosts, databases, and other entities that constitute this system. The system health will be calculated based on these component entities.
Belongs To Entity	Select the upper-level business domain, platform, or parent system to indicate the ownership relationship.
Runtime Dependencies	Select other systems, services, or resources on which this system depends.

4. Team¶

Select the team responsible for maintaining this entity.

5. Custom Tags¶

Select or create tags for categorization and filtering.

6. Contact Information¶

Click + Add to add contact information such as email, phone, Slack, etc. Only the display name is shown to protect privacy; click to view details.

7. Links¶

Click + Add to add external links such as repositories, documentation, views, etc. Repository types automatically recognize the provider's logo.

YAML Mode¶

Switch to the YAML tab to directly edit the configuration file.

Click "Configuration Instructions" in the upper right corner to view the field specifications.

Configuration Example (Service Type):

attributes:
  env: ''
  host: 172.16.161.51
  name: kodo.nsq.producer
  time: '2026-03-30T17:27:01.131146+08:00'
  project: cloudcare-testing
  version: ''
  language: go
  namespace: default
  sourceType: message_queue
  serviceType: message_queue
  clusterNameK8S: ''
  depends_on:
    - service:kodox.nsq.consumer
    - service:kodo.nsq.consumer
  component_of:
    - host:172.16.161.45
    - host:172.16.161.54
    - host:172.16.162.24
    - host:172.16.162.30
  custom_tags: []
  contact: []
  link: []
telemetrySelectors: []

Complete Creation¶

After filling in the information, click "Save". The system will automatically return to the Entity List page, and the newly created entity will be visible immediately.