Entity Groups

Overview

Entity Groups provide a way to organize similar entities into cohesive collections that can be re-used when managing user permissions, filtering data, calculating aggregations etc.

Members

An entity group can be composed by manually specifying names of the entities that are included as members.

It can be also created by specifying a criteria against which all entities that exist in the database are evaluated. Those entities that match the criteria are added as members automatically and the group is continuously updated in the background.

The entity group editor provides the following options for managing entities:

List

Copy a list of entity names, one per line, into the text area. The names are case-insensitive.

If 'Create Entities' option is checked, new entities are automatically created when the form is saved. Otherwise, names for which there are no existing entities found, are ignored.

Selector

Select one or multiple existing entities in the right pane and click 'Add' to add members.

Select current members in the left pane and click 'Remove' to delete members from the group.

Expression

Specify a boolean expression to add/remove entities automatically. Expression-based groups are updated by the server at a fixed interval specified in the entity.group.update.interval setting.

The expression can include the following fields and supports wildcards in field values:

  • name
  • label
  • enabled
  • tags.tag-name or tags['tag-name']

The expression may refer to entity fields, tags and functions to match entities.

name LIKE '*vml*' && tags.location = 'NUR'

Supported Functions

Examples

  • Entity name contains the specified string
name LIKE 'nur*vml*'
  • Entity has the specified entity tag
tags.docker-type != ''
  • Entity has an entity tag equal to the specified value
tags.docker-type = 'container'
  • Entity has entity tags equal to the specified values
tags.docker-type = 'container' && tags.status != 'deleted'
  • Entity collects the specified property type
properties('oem.oracle_database').size() > 0
  • Entity collects the specified metric
hasMetric('mpstat.cpu_busy')
  • Entity collected the specified metric within N hours
hasMetric('mpstat.cpu_busy', 24*7)
  • Entity property tag value matches the given expression
properties('cfg').prog != '' && properties('cfg').prog NOT LIKE 'topas*'
  • Entity is a member of another group
memberOf('all-linux-servers') && tags.location = 'SVL'