Service metrics API - JSON models
Some JSON models of the Calculated service metrics API vary according to the type of some objects. Here you can find JSON models for each variation.
Variations of the ComparisonInfo
object
BOOLEAN
The BooleanComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | boolean | The value to compare to. |
values | boolean[] | The values to compare to. |
json{
"comparison": "EQUALS",
"value": true,
"negate": false,
"type": "BOOLEAN"
}
ESB_INPUT_NODE_TYPE
The ESBInputNodeTypeComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "EVENT_INPUT_NODE",
"negate": false,
"type": "ESB_INPUT_NODE_TYPE"
}
FAILED_STATE
The FailedStateComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "SUCCESSFUL",
"negate": false,
"type": "FAILED_STATE "
}
FAILURE_REASON
The FailureReasonComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "EXCEPTION_ON_ANY_NODE",
"negate": false,
"type": "FAILURE_REASON"
}
FAST_STRING
The FastStringComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. |
values | string[] | The values to compare to. |
caseSensitive | boolean | The comparison is case-sensitive ( |
json{
"comparison": "CONTAINS",
"value": "sample",
"negate": false,
"type": "FAST_STRING"
}
FLAW_STATE
The FlawStateComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "FLAWED",
"negate": false,
"type": "FLAW_STATE"
}
HTTP_METHOD
The HttpMethodComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "POST",
"negate": false,
"type": "HTTP_METHOD"
}
HTTP_STATUS_CLASS
The HttpStatusClassComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "C_2XX",
"negate": false,
"type": "HTTP_STATUS_CLASS"
}
IIB_INPUT_NODE_TYPE
The IIBInputNodeTypeComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "JMS_CLIENT_INPUT_NODE",
"negate": false,
"type": "IIB_INPUT_NODE_TYPE"
}
NUMBER
The NumberComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | number | The value to compare to. |
values | number[] | The values to compare to. |
json{
"comparison": "GREATER_THAN_OR_EQUAL",
"value": {},
"negate": false,
"type": "NUMBER"
}
NUMBER_REQUEST_ATTRIBUTE
The NumberRequestAttributeComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | number | The value to compare to. |
values | number[] | The values to compare to. |
requestAttribute | string | - |
matchOnChildCalls | boolean | If Default is |
source | Propagation | Defines valid sources of request attributes for conditions or placeholders. |
The PropagationSource
object
Defines valid sources of request attributes for conditions or placeholders.
Element | Type | Description |
---|---|---|
managementZone | string | Use only request attributes from services that belong to this management zone.. Use either this or |
serviceTag | Universal | Use only request attributes from services that have this tag. Use either this or |
The UniversalTag
object
Use only request attributes from services that have this tag. Use either this or managementZone
Element | Type | Description |
---|---|---|
tagKey | Universal | - |
value | string | The value of the tag. Not applicable to custom tags. If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used. |
key | string | The key of the tag. For custom tags, put the tag value here. The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags. |
context | string | The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, The element can hold these values
|
The UniversalTagKey
object
Element | Type | Description |
---|---|---|
context | string | - The element can hold these values
|
key | string | - |
json{
"comparison": "GREATER_THAN",
"value": {},
"negate": false,
"type": "NUMBER_REQUEST_ATTRIBUTE",
"requestAttribute": "sample"
}
SERVICE_TYPE
The ServiceTypeComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "BACKGROUND_ACTIVITY",
"negate": false,
"type": "SERVICE_TYPE"
}
STRING
The StringComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. |
values | string[] | The values to compare to. |
caseSensitive | boolean | The comparison is case-sensitive ( |
json{
"comparison": "ENDS_WITH",
"value": "sample",
"negate": false,
"type": "STRING",
"caseSensitive": false
}
STRING_REQUEST_ATTRIBUTE
The StringRequestAttributeComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. |
values | string[] | The values to compare to. |
requestAttribute | string | - |
caseSensitive | boolean | The comparison is case-sensitive ( |
matchOnChildCalls | boolean | If Default is |
source | Propagation | Defines valid sources of request attributes for conditions or placeholders. |
The PropagationSource
object
Defines valid sources of request attributes for conditions or placeholders.
Element | Type | Description |
---|---|---|
managementZone | string | Use only request attributes from services that belong to this management zone.. Use either this or |
serviceTag | Universal | Use only request attributes from services that have this tag. Use either this or |
The UniversalTag
object
Use only request attributes from services that have this tag. Use either this or managementZone
Element | Type | Description |
---|---|---|
tagKey | Universal | - |
value | string | The value of the tag. Not applicable to custom tags. If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used. |
key | string | The key of the tag. For custom tags, put the tag value here. The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags. |
context | string | The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, The element can hold these values
|
The UniversalTagKey
object
Element | Type | Description |
---|---|---|
context | string | - The element can hold these values
|
key | string | - |
json{
"comparison": "BEGINS_WITH",
"value": "sample",
"negate": false,
"type": "STRING_REQUEST_ATTRIBUTE",
"requestAttribute": "myAttribute",
"caseSensitive": false
}
TAG
The TagComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
The TagInfo
object
Tag of a Dynatrace entity.
Element | Type | Description |
---|---|---|
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the The element can hold these values
|
key | string | The key of the tag. Custom tags have the tag value here. |
value | string | The value of the tag. Not applicable to custom tags. |
json{
"comparison": "EQUALS",
"value": {
"context": "CONTEXTLESS",
"key": "myTag"
},
"negate": false,
"type": "TAG"
}
ZOS_CALL_TYPE
The ZosComparisonInfo
object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.
Element | Type | Description |
---|---|---|
comparison | string | Operator of the comparision. You can reverse it by setting negate to The element can hold these values
|
value | string | The value to compare to. The element can hold these values
|
values | string[] | The values to compare to. The element can hold these values
|
json{
"comparison": "EQUALS",
"value": "IMS_CONNECT_API",
"negate": false,
"type": "ZOS_CALL_TYPE"
}