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
Comparison for BOOLEAN attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
The values to compare to.
{"comparison": "EQUALS","value": true,"negate": false,"type": "BOOLEAN"}
ESB_INPUT_NODE_TYPE
The ESBInputNodeTypeComparisonInfo object
Type-specific comparison information for attributes of type 'ESB_INPUT_NODE_TYPE'.This model also inherits fields from the parent model ComparisonInfo.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
CALLABLE_FLOW_ASYNC_RESPONSE_NODECALLABLE_FLOW_INPUT_NODEDATABASE_INPUT_NODEDOTNET_INPUT_NODEEMAIL_INPUT_NODEEVENT_INPUTEVENT_INPUT_NODEFILE_INPUT_NODEFTE_INPUT_NODEHTTP_ASYNC_RESPONSEJD_EDWARDS_INPUT_NODEJMS_CLIENT_INPUT_NODELABEL_NODEMQ_INPUT_NODEPEOPLE_SOFT_INPUT_NODEREST_ASYNC_RESPONSEREST_REQUESTSAP_INPUT_NODESCA_ASYNC_RESPONSE_NODESCA_INPUT_NODESIEBEL_INPUT_NODESOAP_INPUT_NODETCPIP_CLIENT_INPUT_NODETCPIP_CLIENT_REQUEST_NODETCPIP_SERVER_INPUT_NODETCPIP_SERVER_REQUEST_NODETIMEOUT_NOTIFICATION_NODEWS_INPUT_NODE
The values to compare to.
CALLABLE_FLOW_ASYNC_RESPONSE_NODECALLABLE_FLOW_INPUT_NODEDATABASE_INPUT_NODEDOTNET_INPUT_NODEEMAIL_INPUT_NODEEVENT_INPUTEVENT_INPUT_NODEFILE_INPUT_NODEFTE_INPUT_NODEHTTP_ASYNC_RESPONSEJD_EDWARDS_INPUT_NODEJMS_CLIENT_INPUT_NODELABEL_NODEMQ_INPUT_NODEPEOPLE_SOFT_INPUT_NODEREST_ASYNC_RESPONSEREST_REQUESTSAP_INPUT_NODESCA_ASYNC_RESPONSE_NODESCA_INPUT_NODESIEBEL_INPUT_NODESOAP_INPUT_NODETCPIP_CLIENT_INPUT_NODETCPIP_CLIENT_REQUEST_NODETCPIP_SERVER_INPUT_NODETCPIP_SERVER_REQUEST_NODETIMEOUT_NOTIFICATION_NODEWS_INPUT_NODE
{"comparison": "EQUALS","value": "EVENT_INPUT_NODE","negate": false,"type": "ESB_INPUT_NODE_TYPE"}
FAILED_STATE
The FailedStateComparisonInfo object
Comparison for FAILED_STATE attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
FAILEDSUCCESSFUL
The values to compare to.
FAILEDSUCCESSFUL
{"comparison": "EQUALS","value": "SUCCESSFUL","negate": false,"type": "FAILED_STATE "}
FAILURE_REASON
The FailureReasonComparisonInfo object
Comparison for FAILURE_REASON attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
EXCEPTION_AT_ENTRY_NODEEXCEPTION_ON_ANY_NODEHTTP_CODEREQUEST_ATTRIBUTESPAN_FAILURE
The values to compare to.
EXCEPTION_AT_ENTRY_NODEEXCEPTION_ON_ANY_NODEHTTP_CODEREQUEST_ATTRIBUTESPAN_FAILURE
{"comparison": "EQUALS","value": "EXCEPTION_ON_ANY_NODE","negate": false,"type": "FAILURE_REASON"}
FAST_STRING
The FastStringComparisonInfo object
Comparison for FAST_STRING attributes. Use it for all service property attributes.
The comparison is case-sensitive (true) or not case-sensitive (false).
Operator of the comparision. You can reverse it by setting negate to true.
CONTAINSEQUALSEQUALS_ANY_OF
The value to compare to.
The values to compare to.
{"comparison": "CONTAINS","value": "sample","negate": false,"type": "FAST_STRING"}
FLAW_STATE
The FlawStateComparisonInfo object
Comparison for FLAW_STATE attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
FLAWEDNOT_FLAWED
The values to compare to.
FLAWEDNOT_FLAWED
{"comparison": "EQUALS","value": "FLAWED","negate": false,"type": "FLAW_STATE"}
HTTP_METHOD
The HttpMethodComparisonInfo object
Comparison for HTTP_METHOD attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
CONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACEUNKNOWN
The values to compare to.
CONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACEUNKNOWN
{"comparison": "EQUALS","value": "POST","negate": false,"type": "HTTP_METHOD"}
HTTP_STATUS_CLASS
The HttpStatusClassComparisonInfo object
Comparison for HTTP_STATUS_CLASS attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
C_1XXC_2XXC_3XXC_4XXC_5XXNO_RESPONSE
The values to compare to.
C_1XXC_2XXC_3XXC_4XXC_5XXNO_RESPONSE
{"comparison": "EQUALS","value": "C_2XX","negate": false,"type": "HTTP_STATUS_CLASS"}
IIB_INPUT_NODE_TYPE
The IIBInputNodeTypeComparisonInfo object
Comparison for IIB_INPUT_NODE_TYPE attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
CALLABLE_FLOW_ASYNC_RESPONSE_NODECALLABLE_FLOW_INPUT_NODEDATABASE_INPUT_NODEDOTNET_INPUT_NODEEMAIL_INPUT_NODEEVENT_INPUTEVENT_INPUT_NODEFILE_INPUT_NODEFTE_INPUT_NODEHTTP_ASYNC_RESPONSEJD_EDWARDS_INPUT_NODEJMS_CLIENT_INPUT_NODELABEL_NODEMQ_INPUT_NODEPEOPLE_SOFT_INPUT_NODEREST_ASYNC_RESPONSEREST_REQUESTSAP_INPUT_NODESCA_ASYNC_RESPONSE_NODESCA_INPUT_NODESIEBEL_INPUT_NODESOAP_INPUT_NODETCPIP_CLIENT_INPUT_NODETCPIP_CLIENT_REQUEST_NODETCPIP_SERVER_INPUT_NODETCPIP_SERVER_REQUEST_NODETIMEOUT_NOTIFICATION_NODEWS_INPUT_NODE
The values to compare to.
CALLABLE_FLOW_ASYNC_RESPONSE_NODECALLABLE_FLOW_INPUT_NODEDATABASE_INPUT_NODEDOTNET_INPUT_NODEEMAIL_INPUT_NODEEVENT_INPUTEVENT_INPUT_NODEFILE_INPUT_NODEFTE_INPUT_NODEHTTP_ASYNC_RESPONSEJD_EDWARDS_INPUT_NODEJMS_CLIENT_INPUT_NODELABEL_NODEMQ_INPUT_NODEPEOPLE_SOFT_INPUT_NODEREST_ASYNC_RESPONSEREST_REQUESTSAP_INPUT_NODESCA_ASYNC_RESPONSE_NODESCA_INPUT_NODESIEBEL_INPUT_NODESOAP_INPUT_NODETCPIP_CLIENT_INPUT_NODETCPIP_CLIENT_REQUEST_NODETCPIP_SERVER_INPUT_NODETCPIP_SERVER_REQUEST_NODETIMEOUT_NOTIFICATION_NODEWS_INPUT_NODE
{"comparison": "EQUALS","value": "JMS_CLIENT_INPUT_NODE","negate": false,"type": "IIB_INPUT_NODE_TYPE"}
NUMBER
The NumberComparisonInfo object
Comparison for NUMBER attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTSGREATER_THANGREATER_THAN_OR_EQUALLOWER_THANLOWER_THAN_OR_EQUAL
The value to compare to.
The values to compare to.
{"comparison": "GREATER_THAN_OR_EQUAL","value": {},"negate": false,"type": "NUMBER"}
NUMBER_REQUEST_ATTRIBUTE
The NumberRequestAttributeComparisonInfo object
Comparison for NUMBER_REQUEST_ATTRIBUTE attributes, specifically of the generic Number type.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTSGREATER_THANGREATER_THAN_OR_EQUALLOWER_THANLOWER_THAN_OR_EQUAL
If true, the request attribute is matched on child service calls.
Default is false.
The value to compare to.
The values to compare to.
The PropagationSource object
Defines valid sources of request attributes for conditions or placeholders.
Use only request attributes from services that belong to this management zone.. Use either this or serviceTag
Use only request attributes from services that have this tag. Use either this or managementZone
The UniversalTag object
Use only request attributes from services that have this tag. Use either this or managementZone
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.
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, CONTEXTLESS set.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
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.
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.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
{"comparison": "GREATER_THAN","value": {},"negate": false,"type": "NUMBER_REQUEST_ATTRIBUTE","requestAttribute": "sample"}
SERVICE_TYPE
The ServiceTypeComparisonInfo object
Comparison for SERVICE_TYPE attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
BACKGROUND_ACTIVITYCICS_SERVICECUSTOM_SERVICEDATABASE_SERVICEENTERPRISE_SERVICE_BUS_SERVICEEXTERNALIBM_INTEGRATION_BUS_SERVICEIMS_SERVICEMESSAGING_SERVICERMI_SERVICERPC_SERVICESPAN_SERVICEUNIFIED_SERVICEWEB_REQUEST_SERVICEWEB_SERVICEZOS_CONNECT_SERVICE
The values to compare to.
BACKGROUND_ACTIVITYCICS_SERVICECUSTOM_SERVICEDATABASE_SERVICEENTERPRISE_SERVICE_BUS_SERVICEEXTERNALIBM_INTEGRATION_BUS_SERVICEIMS_SERVICEMESSAGING_SERVICERMI_SERVICERPC_SERVICESPAN_SERVICEUNIFIED_SERVICEWEB_REQUEST_SERVICEWEB_SERVICEZOS_CONNECT_SERVICE
{"comparison": "EQUALS","value": "BACKGROUND_ACTIVITY","negate": false,"type": "SERVICE_TYPE"}
STRING
The StringComparisonInfo object
Comparison for STRING attributes.
The comparison is case-sensitive (true) or not case-sensitive (false).
Operator of the comparision. You can reverse it by setting negate to true.
BEGINS_WITHBEGINS_WITH_ANY_OFCONTAINSENDS_WITHENDS_WITH_ANY_OFEQUALSEQUALS_ANY_OFEXISTSREGEX_MATCHES
The value to compare to.
The values to compare to.
{"comparison": "ENDS_WITH","value": "sample","negate": false,"type": "STRING","caseSensitive": false}
STRING_REQUEST_ATTRIBUTE
The StringRequestAttributeComparisonInfo object
Comparison for STRING_REQUEST_ATTRIBUTE attributes, specifically of the String type.
The comparison is case-sensitive (true) or not case-sensitive (false).
Operator of the comparision. You can reverse it by setting negate to true.
BEGINS_WITHBEGINS_WITH_ANY_OFCONTAINSENDS_WITHENDS_WITH_ANY_OFEQUALSEQUALS_ANY_OFEXISTSREGEX_MATCHES
If true, the request attribute is matched on child service calls.
Default is false.
The value to compare to.
The values to compare to.
The PropagationSource object
Defines valid sources of request attributes for conditions or placeholders.
Use only request attributes from services that belong to this management zone.. Use either this or serviceTag
Use only request attributes from services that have this tag. Use either this or managementZone
The UniversalTag object
Use only request attributes from services that have this tag. Use either this or managementZone
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.
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, CONTEXTLESS set.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
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.
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.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
{"comparison": "BEGINS_WITH","value": "sample","negate": false,"type": "STRING_REQUEST_ATTRIBUTE","requestAttribute": "myAttribute","caseSensitive": false}
TAG
The TagComparisonInfo object
Comparison for TAG attributes.
The TagInfo object
Tag of a Dynatrace entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_CLOUDKUBERNETES
The key of the tag.
Custom tags have the tag value here.
The value of the tag.
Not applicable to custom tags.
{"comparison": "EQUALS","value": {"context": "CONTEXTLESS","key": "myTag"},"negate": false,"type": "TAG"}
ZOS_CALL_TYPE
The ZosComparisonInfo object
Comparison for ZOS_CALL_TYPE attributes.
Operator of the comparision. You can reverse it by setting negate to true.
EQUALSEQUALS_ANY_OFEXISTS
The value to compare to.
CTGDPLEXPLICIT_ADKHTTPIMS_CONNECTIMS_CONNECT_APIIMS_ITRAIMS_MSCIMS_PGM_SWITCHIMS_SHARED_QUEUESIMS_TRANS_EXECMQSOAPSTARTTTXTXUNKNOWNZOS_CONNECT
The values to compare to.
CTGDPLEXPLICIT_ADKHTTPIMS_CONNECTIMS_CONNECT_APIIMS_ITRAIMS_MSCIMS_PGM_SWITCHIMS_SHARED_QUEUESIMS_TRANS_EXECMQSOAPSTARTTTXTXUNKNOWNZOS_CONNECT
{"comparison": "EQUALS","value": "IMS_CONNECT_API","negate": false,"type": "ZOS_CALL_TYPE"}