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 in the console to help quickly understand field meanings and apply fields.
Official Fields¶
Official fields are default fields provided by Guance. You can view all official fields in the workspace Manage > Field Management, including field names, field types, and detailed field descriptions.
Note
Official fields cannot be deleted.
Custom Fields¶
Custom fields are fields added by users based on collected data, including collected metrics, tags, fields parsed through Pipeline, etc.
Create¶
Go to the workspace Manage > Field Management, and click Create.
| Information | Description |
|---|---|
| Field Name | Required, must not exceed 128 characters; if there is a duplicate name, an error will occur |
| Alias | Required, descriptive name of 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. |
| Attribute Class | Includes system fields (selected by default), business fields, others |
| Description | Further supplementary explanation and description of the current field |
Options¶
After the field is created, you can perform the following operations on custom fields:
- Perform a fuzzy search by entering the field name;
- Set the 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 will become a custom field, and you can edit and delete it.
Note
If a custom field is deleted, the original overwritten field will be displayed as an official field again, and editing and deletion will no longer be supported.
Use Cases¶
After data is reported to the Guance 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 Use Cases > Dashboards, select a chart, and in Query, you can view the field description.
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 Filter, Display Items.
1. Quick Filter
2. Display Items
Based on field attributes, system fields (selected by default), business fields, and others will be displayed here.
3. Explorer Chart Mode
In the workspace Monitoring > Monitors, select a monitor, and in Detection Metrics, you can view the field description.
Note
If the detection metric selects the count or count_distinct function, the unit is not displayed.
In the workspace Shortcut > Query Tool, switch to Simple Query, and you can view the field description.
In the workspace Metrics > Metric Analysis, you can view the field description in the simple query.
