getSeriesProperties

getSeriesProperties("{entity}","{property_type}")

getSeriesProperties("{entity}", "{property_type}")

Returns property objects for a specified entity and property type.

Retrieve a collection of property objects for specified entity and property type.
If no entity is specified, then a collection of property objects for all entities with the specified property type is retrieved.

getTagMaps

getTagMaps('metric','entity'[, hours])

getTagMaps('metric', 'entity'[, hours])

Returns collection of maps(string, string).

Retrieve a collection of unique tag maps for metric and entity.
[, hours] is an optional parameter, which specifies the time interval (in hours) for searching unique tag values.
Default interval is 24 hours.

getEntitiesForGroup:

getEntitiesForGroup('group')

getEntitiesForGroup('group')

getEntitiesForGroup('group','hours')

getEntitiesForGroup('group', 'hours')

Returns a string collection.

Find all entities in a particular entity group, which is useful when building portals that compare entities from the same entity group.
The method returns group member that have inserted data over the last N hours.
If hours is not specified or non-positive, all group members are returned.

A single line of freemarker code can be used to easily customize the results of the portal by searching for entity tags rather than specific entities giving extensive possibilities to create flexible portals.

The freemarker search can be for any combination of tags. For example: application, data center and function. Only entities that have all three specified tags will be loaded into the portal.

In the response, freemarker [series] are substituted with the matching entities, creating [series] for each of them.

Freemarker Expressions Summary Table

Collection of tag values for tagKey of all entity groups an entity belongs to

tag('entity', 'tagKey')

string

Entity tag value.

memberOf('entity', 'group1', ..., 'groupN')

boolean

Returns true if an entity belongs to any specified of the entity groups.

memberOfAll('entity', 'group1', ..., 'groupN')

boolean

Returns true if an entity belongs to all of the entity groups.

list('value' [, delimiter])

string collection

Splits a string by a delimeter. Default delimiter is comma character.

getTags('metric', 'entity', 'tagKey'[, hours])

string collection

Tag values for metric, entity, and tagKey.
[, hours] is an optional parameter, which specifies the time interval (in hours) for searching unique tag values.
Default interval is 24 hours.

getEntitiesForTags(expression)

string collection

Find entities by expression.

getEntitiesForGroup("group")

string collection

Find all entities in a particular entity group. Useful when building portals that compare entities from the same entity group.

getEntitiesForGroup(groupName, hours)

string collection

Find all entities in a particular entity group. Useful when building portals that compare entities from the same entity group.
The method returns group member that have inserted data over the last N hours.
If hours is not specified or non-positive, all group members are returned.

getMetrics('entity')

string collection

Retrieve all collected metrics for a particular entity.

isMetric('metric')

boolean

Returns true if a metric exists.

isMetricCollected('metric', 'entity')

boolean

Returns true if there is some data for the metric and entity inserted in the last 24 hours.

hasMetric('entity', 'metric' [,hours])

boolean

Executes query for Last Insert Cache table and returns true if the entity collects the specified metric, regardless of tags.
If the optional hours argument is specified, only rows inserted for the last N hours are evaluated.

getTagMaps('metric', 'entity'[, hours])

collection of maps(string, string)

Collection of unique tag maps for metric and entity.
[, hours] is an optional parameter, which specifies the time interval (in hours) for searching unique tag values.
Default interval is 24 hours.

getProperty('entity', 'property_type', 'tagKey')

string collection

Retrieve a collection of property objects for specified entity, property type, and tag.

getSeriesProperties("{entity}", "{property_type}")

property objects for specified entity and property type

Retrieve a collection of property objects for specified entity and property type.
If no entity is specified, then a collection of property objects for all entities with the specified property type is retrieved.

atsd_values(entity, metric, tags, type, interval, shift, duration)

Aggregator object

See tables below.

lastInsertTime('entity'[, ‘metric’])

Double

Returns last insert time for the entity or entity/metric combination in milliseconds. Metric is an optional parameter.

lastInsertDate('entity'[, ‘metric’])

Double

Returns last insert date for the entity or entity/metric combination in ISO format. Metric is an optional parameter.