Learn how to use tags to speed up searching and query display and how to manage entity tags.

A tag is custom metadata that adds application-specific meaning to Wavefront entities: alerts, dashboards, events, and sources and metrics. Tags group together entities and metrics according to categories you define.

For an overview of how tags can help you organize your data and improve searches, watch this video: Using Tags

Why Tags?

You use tags to limit the number entities and metrics you are working with or querying at once. Limiting the number of entities reduces information overload. Limiting the number of metrics reduces the time to display results.

In the Wavefront UI and API you can use entity tags to filter alert, dashboard, event, and source entities. In the Wavefront UI, entity tags display as gray labeled icons tag in the filter bar and below each entity in the entity browser.

In ts() and events() queries, you can filter:

  • Metrics with source and point tags
  • Events with:
    • alert and event entity tags
    • system severity, subtype, and type tags added by alerts

Tag Types

The table summarizes where the two types of tags are used and where they are added and updated.

Tag Type Used in UI and API Used in Queries Where Added and Updated
alert Alert Management and Preventing Alerts from Firing Basic events() Queries Wavefront UI and API
dashboard Managing Dashboards Wavefront UI and API

Dashboards added by Wavefront have system tags that start with ~, e.g. ~integration.aws or ~welcome.tutorial.
event Managing Events Basic events() Queries system tags added by alerts

entity tags added in the Wavefront UI and API
point Wavefront Data Format and Point Tags in Queries Wavefront proxy
Configuring Wavefront Proxy Preprocessor Rules

Telegraf agent
Wavefront CLI
source Managing Sources and Managing Maintenance Windows Getting Started with Wavefront Query Language Wavefront UI and API

Tag Paths

All tag types support the ability to organize tags in a hierarchy. The hierarchy is defined by separating tag components with a dot “.”. For example: MyService.MyApp. Dashboards provided by Wavefront start with a tilde at the beginning of the tag, for example, ~welcome., ~integration., and ~system.. To improve readability, tags retain case for display but they are treated as case-insensitive for searching, sorting, etc.

Selecting and Searching Tag Paths

In the UI you operate on tag paths by selecting a component at a specific node in the hierarchy.  For example:

  • Select all Wavefront dashboards by clicking wavefront
  • Select only tutorial dashboards by expanding the wavefront node and selecting wavefront.tutorial.

In queries, you achieve the same effect by using trailing wildcards “.*” when you specify tag paths. For example, to match all tags starting with alertTagPath., enter alertTagPath.*. This string matches alerts named alertTagPath.tpc1, alertTagPath.tpc1.tpc11, etc.

When you create maintenance windows you can use tag paths and wildcards to put a group of of alerts in maintenance.

Managing Entity Tags

Entity tags are tags that apply to Wavefront entities: alerts, dashboards, events, and sources.

Adding Entity Tags

To add tags to one or more entities:

  1. Open an entity browser.
    • For some entities, you select Browse > <entity>, where <entity> is Sources or Events.
    • For other entities, such as Alerts, you click the entity.
  2. Choose which entities to tag:
    • Check the checkboxes next to the entities and click the + Tag button.
    • Click + at the bottom and select a tag or click Create New Tag.

      source tags

  3. In the Add Tag dialog, click the Create Tag button at the bottom.
  4. Type a tag name. Tag names can contain alphanumeric (a-z, A-Z, 0-9), dash (-), underscore (_), and colon (:) characters. Tag names are case sensitive. For example, the tags MyApp and myapp are stored as distinct tags. However, mixed case tag paths are collapsed into one path; MyService.myapp and myservice.myapp are collapsed into Myservice.myapp.
  5. Click Add.

Searching for Entity Tags

When you have many tags in your environment, you can search for tags by typing tag names in the Search box below the Tags heading in the filter bar on the left. As you type, the list of tags is filtered by the search string.

Note When you search for tags, the search process is case insensitive. For example, searching for the tag myapp returns MyApp and myapp..

Filtering by Entity Tags

To filter by a tag, click a tag icon. You can click the icon in the filter bar on the left or below an entity in an entity browser.