getMetrics (GetMetrics)

Takes a MetricQuery and uses the OrchestrationIds inside it to retrieve Metrics stored in flow associated with those Orchestrations returning them in the form of MetricQueryResponse. Metrics are retained for one week.

Class names

scala: code.model.flows.processors.state.GetMetricsScannable
javascript: code_model_flows_processors_state_GetMetricsScannable

Aliases

Coercions

RequiredFields: {
orchIds or
orchestrations or
ids or
orchestrationIds or
orchestrationIdentities
used to define
orchestrationIds
}
OptionalFields: {
count
used to define
count
recursive
used to define
recursive
skip
used to define
skip
}
DefaultParameter: {
recursive defaults to false
}

Config

{"bindingHint":"Retrieves metrics from previously run Flow Orchestrations. Metrics are stored for one week.","categories":[{"defaultCollapsed":true,"fields":["testData","testDataTransformFunc","assertionFunc"],"name":"Testing"}],"fieldName":"getMetrics","fields":[{"default":null,"fieldName":"getMetrics.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"getMetrics","fieldName":"getMetrics.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"getMetrics.testDataTransformFunc","hidden":false,"hideLabel":false,"name":"testDataTransformFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":"${generatedId}","fieldName":"getMetrics.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"getMetrics.testData","hidden":false,"hideLabel":false,"name":"testData","readonly":false,"renderStrategies":[],"type":"Jv","validators":[]},{"default":null,"fieldName":"getMetrics.assertionFunc","hidden":false,"hideLabel":false,"name":"assertionFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]}],"hidden":false,"hideLabel":false,"label":"getMetrics","name":"getMetrics","readonly":false,"renderStrategies":[],"type":"O"}