Field Management¶
The system supports unified management of field data in the current workspace, including two types:
You can view field descriptions in different Use Cases within the console to help quickly understand field meanings and apply them.
Official Fields¶
Official Fields are default fields provided by Guance. You can view all official fields in the workspace under Manage > Field Management, including the field name, field type, and a detailed description of the field.
Note
Official Fields cannot be deleted.
Custom Fields¶
Custom Fields are fields added by users based on the collected data, including collected Metrics, tags, fields parsed by Pipeline, etc.
Create¶
Go to Manage > Field Management in the workspace and click Create.
| Information | Description |
|---|---|
| Field Name | Required, cannot exceed 128 characters. An error will occur if a duplicate name exists. |
| Alias | Required, the descriptive name of the field. |
| Field Source | Includes General Fields, LOG, Basic Objects, Resource Catalog, Event, APM, RUM, Network. |
| Type | Includes int, float, boolean, string, long. |
| Unit | Includes components such as percentage, length, and custom units. ❗️After the field is created, the unit will be automatically displayed everywhere the field is applied, e.g., Monitors, Explorers, Charts, etc. |
| Attribute Class | Includes System Fields (selected by default), Business Fields, Others. |
| Description | Further supplementary explanations and descriptions for the current field. |
Options¶
After a field is created, you can perform the following operations on custom fields:
- Perform a fuzzy search by entering the field name;
- Configure display columns;
- Edit: Update the field name, field type, attribute class, and field description for the current field;
- Delete the field;
- Overwrite: When creating a new field, if it conflicts with an official field, you can choose to overwrite the official field. After overwriting, this field becomes a custom field, and you can edit and delete it.
Note
If a custom field is deleted, the originally overwritten 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 first provide descriptions for the reported field data in Field Management. This helps other team members quickly understand field meanings and apply them when using fields for data querying and analysis.
In the workspace under Scenarios > Dashboards, select a chart. You can view the field description in the Query section.
Note
The unit is not displayed when the count or count_distinct function is selected.
In the Explorer, you can view fields and their corresponding field information in Explorer > Quick Filters, Display Items.
1. Quick Filters
2. Display Items
Based on field attributes, System Fields (selected by default), Business Fields, and Others are displayed here respectively.
3. Explorer Chart Mode
In the workspace under Monitoring > Monitors, select a monitor. You can view the field description in the Detection Metric section.
Note
If the detection metric selects the count or count_distinct function, the unit is not displayed.
In the workspace under Shortcut > Query Tool, switch to Simple Query to view field descriptions.
In the workspace under Metrics > Metric Analysis, you can view field descriptions in the simple query.
