Field Management¶
Guance supports unified management of field data in the current workspace, including official fields and custom fields. You can view field descriptions in different use cases in the Guance console to help quickly understand the meaning of fields for application.
Official Fields¶
Official fields are the default fields provided by Guance. You can view all official fields under Management > Field Management, including field names, field types, and detailed 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 split via Pipeline, etc.
Create Field¶
You can go to Management > Field Management and click Create Field:
| Information | Description |
|---|---|
| Field Name | Required, must not exceed 128 characters; if a duplicate name exists, an error will occur. |
| Alias | Required, descriptive name of the field. |
| Source | Includes common fields, logs, base objects, resource catalog, events, APM, RUM, security check, network. |
| Type | Includes int, float, boolean, string, long. |
| Unit | Includes percentage, length, custom units, etc. After the field is created, all places where the field is applied will automatically display the unit, for example: monitors, explorers, charts, etc. |
| Description | Further supplementary explanation and description of the current field. |
List Operations¶
After creating fields, you can perform the following operations on custom fields:
Click to set up 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 fuzzy searches for field names.
When creating a new field, if it conflicts with an official field, you can choose to override the official field. After overriding, the field becomes a custom field, which you can edit and delete.
Note: If you delete this custom field, the originally overridden field will reappear as an official field and will no longer support editing or deletion.
Use Cases¶
After data is reported to the Guance workspace, you can provide explanations for the reported field data in Field Management to help other team members quickly understand the meaning of the fields when using them for data queries and analysis.
In the workspace Use Case > Dashboard, select a chart, and in Query, you can view field descriptions.
Note: Units are not displayed when selecting count or count_distinct functions.
In the explorer, you can view fields and their corresponding information in Explorer > Quick Filter, Add Display Columns.
Quick Filter
Add Display Columns
Analysis Dimensions
In the workspace Monitoring > Monitors, select a monitor, and in Detection Metrics, you can view field descriptions.
Note: Units are not displayed if the detection metric selects the count or count_distinct function.
In the workspace Shortcut > Query Tool, switch to Simple Query to view field descriptions.
In the workspace Metrics > Metric Analysis, you can view field descriptions in simple queries.
