Custom¶
Besides hosts, containers and processes, Guance supports customizing new infrastructure types and reporting relevant data to the Guance console.
Guance supports you in classifying custom infrastructure types, helping you track and store custom data of the same type.
Add¶
In the Guance workspace, you can create new custom and customize its names and fields through Infrastructure > Custom > Add Custom.
-
Custom: This is the name when conducting custom data reporting. When reporting data, you need to ensure that the name matches the naming used during data reporting.
-
Alias: This is the name under which the current custom is displayed in the list of custom infrastructure types.
-
Required Attributes: The fields that must be included in the data; the
name
field of the custom is added by default. If the reported data does not include the fields you have set, it will not be reported to Guance, thus filtering out non-standard data.
Data Report¶
After adding custom, you can proceed with custom data reporting. Before that, you need to install and connect DataKit and DataFlux Func, and then report data to DataKit through DataFlux Func. Finally, the data will be reported to the Guance workspace through DataKit.
See Custom Data Report for the specific operation process.
Note:
-
Custom fields in the Required Attributes are required when reporting data. If any of the required fields are missing in the reported data, the data will not be uploaded to the Guance workspace.
-
If the reported data type does not match the defined field data type, the data will not be uploaded to the Guance workspace. For example, if a field is defined as a character type in DataFlux Func, but the reported data type is an integer, the data will not be uploaded to the Guance workspace.
-
Custom will be cleared after 48 hours of being offline.
Modify¶
In the category list on the page, you can click the button: - Settings for existing categories, including changing the alias of existing categories and adding/removing fields; - Add the current custom to the secondary menu for easy access.
Note: After adding fields, the original data remains unchanged, and the data reported later must contain the newly added fields.
Delete¶
Guance supports Owner and Administrator to delete the specified custom classification and all custom, enter Management > Settings > Delete Custom Objects, and select the method of deleting custom to delete the corresponding data.
- All custom: Delete all custom data and indexes.
- Specify custom classification: Only the data under the selected classification will be deleted, and the index will not be deleted.
Note: Once all custom are deleted, all data and indexes reported to infrastructure customization will be deleted and cannot be recovered. All set custom classification data need to be re-reported, and all custom are limited to be deleted 5 times a day.
Filter¶
You can add filters for custom.
Click on Add workspace-level filter and the settings button to start adding.
Note: Workspace-level filters can only be added by the workspace Owner and Administrator.
Click on the edit button to add personal-level filters. Adding them will not affect the explorer layout for other members of the workspace.
See Filter.
Details Page¶
After custom data is reported, click on the name in the custom list to bring up the details page and view the detailed information, including the name, category, attributes, etc.
Information¶
By clicking on the tab Host
on the custom details page, you can do the following:
-
Add to Filter: add the tag to the Container List Explorer to view all Container data associated with the host.
-
Copy: copy the contents of the label to the local clipboard.
-
View related logs/containers/processes/links/inspection: view all logs related to corresponding data.
Customize Inner Views¶
Guance supports setting up binding or deleting inner views (user views) to the details page of custom infrastructure. After binding the inner views, the bound views can be viewed in the details of the custom.
Note: Before binding a inner view, you need to confirm whether the view variable in the bound inner view has a field related to the classification, such as host
. See Binding Inner Views.