Configure Metadata Export Filter for AMX

Note: Metadata export filter is now available as an Early Access feature, giving you the opportunity to explore its capabilities before the general availability (GA).

An export filter can be configured to control which metadata records are exported from the Application Metadata Exporter (AMX) to downstream tools such as Kafka. By defining a filter condition, only records that satisfy the specified criteria are exported, reducing unnecessary data volume sent to the target tool. This is an optional functionality that can be used as per the requirement.

The Application Metadata Exporter generally stores all received metadata records in an internal ClickHouse database. The export filter applies a ClickHouse query condition at the exporter component. When the filter is active, only records matching the condition are exported; all other records are dropped before reaching the tool.

Rules and Notes

■

The export filter can only be configured by directly editing the /etc/amx_settings.yaml file on the V Series Node. This option is not available through GigaVUE-FM.

■

The backend does not validate the filter string. Ensure that the value of set_export_filters is a valid ClickHouse sub-query. An invalid query may result in no records being exported.

■

If the filter is misconfigured or contains an invalid ClickHouse sub-query, AMX does not return an explicit error. Instead, no metadata records are exported. To diagnose such issues, review the AMX logs on the V Series Node for filter-related error messages. Log files are located at /var/log/syslog/ on the V Series Node.

To configure the export filter:

Create or edit the /etc/amx_settings.yaml file on the V Series Node where AMX is deployed.

Define the set_export_filters key with a valid ClickHouse sub-query as its value. For example, set_export_filters: "mdata['app_name'] LIKE 'http%'".

To apply the new filter settings, undeploy the monitoring session and then deploy it again.