Settings API - Span service detection configuration schema table

Span service detection configuration (`builtin:span-service-detection-config`)

Configure a list of span service detection rules which are evaluated in order.

When the first rule matches, the service detection will proceed. Subsequent rules will not be evaluated.

Note: This config applies only to spans captured by OneAgent.

Schema ID	Schema groups	Scope
`builtin:span-service-detection-config`	`group:service-detection`	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-service-detection-config`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-service-detection-config`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-service-detection-config`

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property	Label	Type	Description	Required
enabled	Enabled	boolean	If this is true, the rule will be evaluated.	required
rule	Rule	Rule	-	required

Request body objects

The `ExtractionType` object

Property	Label	Type	Description	Required
type	Extract	enum	`Before (marker)` Select the part of a longer string that comes before the given marker string. The marker string is not part of the returned result. If the marker is not found in the input, the resulting value will be empty. `Example: Before("/") on input "AC/DC" returns "AC"` `After (marker)` Select the part of a longer string that comes after the given marker string. The marker string is not part of the returned result. If the marker is not found in the input, the resulting value will be empty. `Example: After("/") on input "AC/DC" returns "DC"` `Between (marker_1, marker_2)` Select the part of a longer string that lies between the marker string 1 and marker string 2 (first occurrence of marker string 1, and first occurrence of marker string 2 after marker string 1). The marker strings are not part of the returned result. If any marker is not found in the input, the resulting value will be empty. `Example: Between("AC", "DC") on input "AC/DC" returns "/"` `SplitAndSelect (marker, selectAtIndex)` The longer string is split into a list of substrings identified by the given marker string. The selectAtIndex parameter allows to pick one of the substrings in the produced list. If the marker is not found in the input, the resulting list will only contain the original value. SelectAtIndex is 1 based, i.e. the first item has index 1. `Example: SplitAndSelect("/", 2) on input "AC/DC" returns "DC"`	required
marker	Marker	text	-	required
marker2	Marker_2	text	-	required
splitAndSelectMarker	selectAtIndex	text	-	required

The `ValueSource` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
attributeKey	Span attribute key	text	-	required
resourceAttributeKey	Resource attribute key	text	-	required

The `Extraction` object

Property Label Type Description Required

uniqueId

Property	Label	Type	Description	Required
uniqueId	Id	text	This unique identifier can be used to reference to the result of the extraction in later steps (f.ex. Service detection & Service method detection) The unique identifier must start with a letter and allows the usage of `numbers` and the following special characters [. _ -]	required
valueSource	Value source	ValueSource	-	required
transformations	Transformations	list	-	required

text

This unique identifier can be used to reference to the result of the extraction in later steps (f.ex. Service detection & Service method detection)

The unique identifier must start with a letter and allows the usage of numbers and the following special characters [. _ -]

required

valueSource Value source ValueSource - required

transformations Transformations list - required

The `EventCondition` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
sourceKey	Key	text	-	required
dataType	Data Type	enum	-	required
stringComparisonType	Comparison Type	enum	-	required
attrKeyStringComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
numComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
attrKeyBoolComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
boolValue	Value	enum	-	required
intValue	Value	integer	-	required
intValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
floatValue	Value	float	-	required
floatValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
strValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
caseSensitive	Case sensitive	boolean	Affects value(s)	required

The `Condition` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
eventConditions	Event conditions	set	Specify event conditions which should be evaluated for this rule. A rule is applied if all of the specified conditions match.	required
sourceKey	Key	text	-	required
resourceAttributeKey	Key	text	-	required
dataType	Data Type	enum	-	required
stringComparisonType	Comparison Type	enum	-	required
attrKeyStringComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
numComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
boolComparisonType	Comparison Type	enum	-	required
attrKeyBoolComparisonType	Comparison Type	enum	Note: `Exists/Does not exist` ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key	required
boolValue	Value	enum	-	required
intValue	Value	integer	-	required
intValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
floatValue	Value	float	-	required
floatValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
strValues	Values	set	If regular comparison type i.e. `Equals` is used, then any of the listed values should match for the condition to be evaluated to true If negated comparison type i.e. `Does not equal` is used, then none of the listed values should match for the condition to be evaluated to true	required
spanKindValue	Values	set	-	required
caseSensitive	Case sensitive	boolean	Affects value(s)	required

The `ServiceIdContributor` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
sourceKey	Key	text	-	required
resourceAttributeKey	Key	text	-	required
extractionValue	Extraction id	text	-	required

The `MethodIdContributor` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
sourceKey	Key	text	-	required
resourceAttributeKey	Key	text	-	required
extractionValue	Extraction id	text	-	required

The `ServiceDetection` object

Property Label Type Description Required

outputType

Output

Property	Label	Type	Description	Required
outputType	Output	enum	`No service` Any input matching the current rule would not be detected as a service. `Service id and name` The service id is constructed from a set of id contributors. The service name is specified as a format string with placeholders, where each placeholder refers to any of the id contributors. Each service id contributor induces the condition that its input is available. If it is not available, the rule is considered not matching, the rule is not applied, and ruleset evaluation continues.	required
id	Service id contributors	set	-	required
serviceName	Service name	text	`Prefixes`: [SpanAttribute, Extraction, ResourceAttribute] i.e. {SpanAttribute:http.url}, {Extraction:my_variable}, {ResourceAttribute:service.name} `Well-known placeholders`: {SpanName}, {SpanKind}, {InstrumentationScopeName}, {InstrumentationScopeVersion} Span attributes must be allow-listed in order to be used as a service name Resource attributes must be allow-listed in order to be used as a service name	required

enum

No service

Any input matching the current rule would not be detected as a service.

Service id and name

The service id is constructed from a set of id contributors. The service name is specified as a format string with placeholders, where each placeholder refers to any of the id contributors.

Each service id contributor induces the condition that its input is available. If it is not available, the rule is considered not matching, the rule is not applied, and ruleset evaluation continues.

required

id Service id contributors set - required

serviceName

Service name

text

Prefixes: [SpanAttribute, Extraction, ResourceAttribute] i.e. {SpanAttribute:http.url}, {Extraction:my_variable}, {ResourceAttribute:service.name}

Well-known placeholders: {SpanName}, {SpanKind}, {InstrumentationScopeName}, {InstrumentationScopeVersion}

Span attributes must be allow-listed in order to be used as a service name
Resource attributes must be allow-listed in order to be used as a service name

required

The `DefaultMethodRule` object

Property	Label	Type	Description	Required
outputType	Output	enum	-	required
id	Id	text	-	required
name	Name	text	-	required

The `ServiceMethodDetectionRule` object

Property	Label	Type	Description	Required
methodRuleName	Rule name	text	-	required
conditions	Method conditions	set	Specify conditions which should be evaluated for this rule. A rule is evaluated if all of the specified conditions match.	required
outputType	Output	enum	`No service` Any input matching the current rule would not be detected at the node. `Method id and name` The method id is constructed from a set of id contributors. The method name is specified as a format string with placeholders, where each placeholder refers to any of the id contributors. Each method id contributor induces the condition that its input is available. If it is not available, the rule is considered not matching, the rule is not applied, and ruleset evaluation continues.	required
id	Method id contributors	set	-	required
methodName	Method name	text	`Prefixes`: [SpanAttribute, Extraction, ResourceAttribute] i.e. {SpanAttribute:http.url}, {Extraction:my_variable}, , {ResourceAttribute:method.name} `Well-known placeholders`: {SpanName}, {SpanKind}, {InstrumentationScopeName}, {InstrumentationScopeVersion} Span attributes must be allow-listed in order to be used as a method name Resource attributes must be allow-listed in order to be used as a method name	required

The `Rule` object

Property	Label	Type	Description	Required
ruleName	Rule name	text	-	required
technology	Technology	text	-	optional
extractions	Extractions (Optional)	list	Specify a list of extractions that are inherently bound to the rule they are defined in. Each extraction is composed of at least one transformation but it can also be constructed from multiple chained transformations. If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.	required
serviceDetection	Service detection	ServiceDetection	-	required
serviceMethodDetectionRule	Service method detection	list	Specify a list of rules which are evaluated in order. When the first rule matches, the service detection will proceed. Subsequent rules will not be evaluated.	required
defaultMethodRule	Default method rule	DefaultMethodRule	Choose whether the span service detection rule should detect a service call or not in case there are no matching `service method detection rules` but the `service detection rule` matches the input.	required
conditions	Conditions	set	Specify all conditions which should be evaluated for this rule. A rule is applied if all of the listed conditions match.	required

Settings API - Span service detection configuration schema table

Span service detection configuration (builtin:span-service-detection-config)

Authentication

Parameters

Request body objects

The ExtractionType object

The ValueSource object

The Extraction object

The EventCondition object

The Condition object

The ServiceIdContributor object

The MethodIdContributor object

The ServiceDetection object

The DefaultMethodRule object

The ServiceMethodDetectionRule object

The Rule object

Span service detection configuration (`builtin:span-service-detection-config`)

The `ExtractionType` object

The `ValueSource` object

The `Extraction` object

The `EventCondition` object

The `Condition` object

The `ServiceIdContributor` object

The `MethodIdContributor` object

The `ServiceDetection` object

The `DefaultMethodRule` object

The `ServiceMethodDetectionRule` object

The `Rule` object