Work with query tags

Daria Barysheva

Starting with 4.7.5, ADB Control supports query tagging — assigning custom metadata to SQL queries in the form of <key>: <values> pairs. You can set tags for a session or transaction in ADB and then view and filter these tags on the Monitoring → Commands, Monitoring → Transactions, and Monitoring → Sessions pages in ADB Control. Tags are assigned to ADB queries via the query_band GUC. This functionality can be useful for monitoring query groups, for example, as part of the common ETL process.

Below is an example of working with query tags:

  1. Open the first session in ADB (e.g. by connecting to the adb database on the master host via psql).

  2. Set values for two tags at the session level:

    SET query_band = 'key1: value1,key2: value2';

  3. Run any SQL query that lasts long enough to appear in the ADB Control web interface.

  4. Within the second ADB session, set a different value for the key2 tag:

    SET query_band = 'key1: value1,key2: value3';

  5. Run another SQL query within the second session.

  6. Go to the Monitoring → Commands → Online page in the ADB Control web UI. Tag values for both running queries are shown in the Tags column. The same column is available on the Monitoring → Commands → History, Monitoring → Transactions (Online and History), and Monitoring → Sessions pages.

    Tags in ADB Control
    Tags in ADB Control
    Tags in ADB Control
    Tags in ADB Control

  7. To select the queries with the specific tag value, open a drop-down list in the Tags column header, set the tag value in the Tag column as <key>: <value>, and click the add dark add light icon. To remove any tag from the filter, click close dark close light.

    Filter by the first tag value
    Filter by the first tag value
    Filter by the first tag value
    Filter by the first tag value

    As a result of filtering, both queries are left on the page, because for both of them value1 is set as the key1 value.

    Filtering result for one tag
    Filtering result for one tag
    Filtering result for one tag
    Filtering result for one tag

  8. You can add a filter by the second tag value as shown below. Each tag value should be entered separately.

    Add a filter by the second tag value
    Add a filter by the second tag value
    Add a filter by the second tag value
    Add a filter by the second tag value

    After you apply a filter, only the first session query is left on the page.

    Filtering result for two tags
    Filtering result for two tags
    Filtering result for two tags
    Filtering result for two tags

  9. Also, you can filter data by tag names without tag values. As a result, all queries, for which the selected tag is specified, are shown, despite the tag value.

    Filtering by the tag name
    Filtering by the tag name
    Filtering by the tag name
    Filtering by the tag name
Found a mistake? Seleсt text and press Ctrl+Enter to report it