Skip to content

Resource Catalog

By creating custom resources and combining configurations such as attributes, associated views, and JSON text, you can use the DataKit API and DataFlux Func to report any data to TrueWatch, including cloud vendor resource data and enterprise business data. This data can then be visually managed and analyzed in the custom resource explorer in the console.

By creating explorer templates that match the data characteristics for different resource classifications, the data will preferentially apply the created templates when it is ingested into the console. You can use these explorer templates to view and analyze resource catalog data. If no match is found, the templates from the official template library will be applied.

Note
  • Whether or not an explorer template is created for a resource does not affect the reporting and receiving of data;
  • The template supports configuring "required attributes," which are fields that must be included in the data for it to be accepted. This can be used for data filtering and interception.

Data Reporting

Prerequisite

Install DataKit and DataFlux Func.

After adding a resource catalog classification, you can proceed with custom data reporting. Use DataFlux Func to report data to DataKit, which then reports the data to the TrueWatch workspace.

For specific steps, refer to Resource Catalog Data Reporting.

Note
  • Custom fields in required attributes are mandatory fields during data reporting. If the reported data lacks these mandatory fields, the data cannot be reported to the TrueWatch workspace;
  • If the data type reported does not match the defined field data type, the data cannot be reported to the TrueWatch workspace. For example, if a field type is defined as a string in DataFlux Func but an integer is reported, the data will not be reported to the TrueWatch workspace;
  • Resource catalogs will be cleared 48 hours after going offline.

Create Resource Explorer

You can create an explorer in the following ways:

Custom Creation: Click to directly enter the creation page.

Import Explorer Template: Import a template and then edit and modify it.

Start Configuration

Default Configuration

  1. Choose whether to group resources as needed;
  2. Define the resource classification name for resource catalog data reporting;
  3. Required Attributes: Fields that must be included in the data; the name field of the object is added by default. If the reported data does not include the fields you set, it will not be reported to TrueWatch, thus filtering out non-compliant data;
  4. Enter an alias for the resource classification, which will be displayed preferentially in the list after configuration;
  5. Explorer Display Configuration:
    • Default Display Columns: The table headers displayed by default in the explorer table;
    • Default Quick Filters: The filter fields displayed by default in the quick filters on the left side of the explorer;
    • Detail Page Associated Views: Define the view display name, select the view, and fill in the associated fields as needed to bind built-in views or pages;
    • Color Fill Fields: The list of fields used for color filling in honeycomb mode. If not configured, all numeric fields will be listed by default;
    • Group Analysis Fields: The list of fields that can be used for group analysis in honeycomb mode. If not configured, all string fields will be listed by default;
  6. Click Confirm.
Note
  • Built-in views here include all views; if there are duplicates, user views take precedence over system views;
  • Built-in pages include explorer lists (e.g., logs, traces, containers) and network topology page templates.

JSON Configuration

When switching from the default configuration to JSON configuration, if you choose:

  • Yes: The current content will be automatically brought into the JSON configuration;

  • No: Only basic configuration will be provided in JSON mode.

  • Choose whether to group resources as needed;

  • Add required attributes;
  • Modify the JSON configuration as needed;
  • Click Confirm.

Resource Classification

In the resource classification list on the left side of the page, you can perform the following operations:

  • In the search bar, enter a resource name for quick location;
  • Click the button:
    • Modify or Export the existing object classification;
    • Delete the explorer template;
    • Add the resource classification to the secondary menu for easier viewing.
  • Click the collapse button to collapse the resource classification, meeting page display preferences.
  • Add Group: Categorize resource explorers. After adding, click the button on the right side of a single resource to move the current resource to the target group.
    • Click the button on the right side of the group to modify the group name;
    • You can delete the group and choose whether to "only delete the group" or "delete all explorer templates under the group."
Note

After adding fields, the original object data remains unchanged. Subsequently reported data must include the newly added fields.

Delete

Deleting an explorer template here does not delete the data. If the data continues to be reported, the default explorer template will be automatically applied.

If you want to completely delete the data, you can go to Manage > Delete Resource Catalog to perform the deletion.

  • Specify Resource Catalog Classification: Only delete the data under the selected object classification, the index will not be deleted;
  • All Resource Catalogs: Delete all resource catalog data and indexes.
Note
  • Only Owner and Administrator can perform deletion operations;
  • Once all resource catalogs are deleted, all data and indexes reported to the custom infrastructure will be deleted and cannot be recovered. All set resource catalog classification data needs to be reported again, with a limit of 5 deletions per day.

Cross-Workspace Query

Select all workspaces associated with the account to enable cross-space querying of resource list data.

Resource Catalog Explorer

View and analyze resource catalogs in list or honeycomb mode.

Quick Filters

You can add filter options for the resource catalog.

Note

Space-level filter options can only be added by the current workspace Owner and Administrator.

  1. Click the Add Space-Level Filter Option button;
  2. Search or directly add fields in the dropdown;
  3. Click Confirm.

For more details, refer to Explorer Quick Filters.

Detail Page

After resource catalog data is reported, click the name in the explorer resource catalog list on the right side to open the detail page and view detailed information about the object, including the object name, extended attributes, complete information, and associated views.

Basic Attributes

View all attribute fields attached to the resource catalog data.

Associated Views

Bind or delete built-in views (system views, user views) to the infrastructure resource catalog detail page.

Note

Before binding a built-in view, confirm that the view variables in the bound built-in view contain fields related to the resource catalog, such as host.

Further Reading