Field Management¶
TrueWatch supports unified management of field data in the current workspace, including two types: Official Fields and Custom Fields. You can view field descriptions in different Use Cases in the TrueWatch console to help quickly understand field meanings and apply fields.
Official Fields¶
Official Fields are default fields provided by TrueWatch. You can view all official fields in the workspace under Manage > Field Management, including field names, field types, and detailed field descriptions.
Note: Official Fields cannot be modified or deleted.
Custom Fields¶
Custom Fields are fields added by users based on collected data, including collected metrics, tags, fields parsed through Pipeline, etc.
Create Fields¶
You can create fields in the workspace under Manage > Field Management by clicking Create:
| Information | Description |
|---|---|
| Field Name | Required, cannot exceed 128 characters; an error will occur if a duplicate name exists. |
| Alias | Required, a descriptive name for the field. |
| Field Source | Includes general fields, logs, basic objects, Resource Catalog, events, APM, RUM, network. |
| Type | Includes int, float, boolean, string, long. |
| Unit | Includes percentage, length, custom unit components. After the field is created, the unit will be automatically displayed in all places where the field is applied, such as monitors, Explorers, charts, etc. |
| Description | Further explanation and description of the current field. |
Options¶
After a field is created, you can perform the following operations on custom fields:
Click to configure display columns:
You can update the field name, field type, and field description for the current field.
Click to delete the current field.
In the search box, you can perform a fuzzy search on the field name.
When creating a new field, if it conflicts with an official field, you can choose to override the official field. After overriding, the field will become a custom field, and you can edit and delete it.
Note: If this custom field is deleted, the original overridden field will be displayed as an official field again and will no longer support editing or deletion.
Use Cases¶
After data is reported to the TrueWatch workspace, you can first describe the reported field data in Field Management to help other team members quickly understand field meanings and apply fields when querying and analyzing data.
In the workspace under Use Cases > Dashboards, select a chart, and in Query, you can view field descriptions.
Note: When selecting the count or count_distinct function, the unit is not displayed.
In the Explorer, you can view fields and their corresponding field information in Explorer > Quick Filters, Add Display Columns.
Quick Filters
Add Display Columns
Analysis Dimensions
In the workspace under Monitoring > Monitors, select a monitor, and in Detection Metrics, you can view field descriptions.
Note: If the detection metric selects the count or count_distinct function, the unit is not displayed.
In the workspace under Shortcut > Query Tools, switch to Simple Query to view field descriptions.
In the workspace under Metrics > Metric Analysis, in simple queries, you can view field descriptions.
