Settings API - API detection rules schema table

API detection rules (builtin:apis.detection-rules)

Modern applications use a lot of different frameworks, so stacktraces in method hotspots and exceptions can become quite long. APIs allow you to spot a component and the respective ownership that is responsible for a hotspot or degradation faster.

API detection rules look at a stacktrace frame and classify it based on classes (Java, .NET and PHP) or files (Node.js, PHP and GO) depending on the technology. The rules are executed in order and the first match decides the API. Marking APIs as third party will allow you to focus on non-third party APIs.

Schema IDSchema groupsScope
builtin:apis.detection-rules
  • group:service-monitoring
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:apis.detection-rules
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:apis.detection-rules
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:apis.detection-rules

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

PropertyTypeDescriptionRequired
API name
apiName		text-required
Color
apiColor		text

This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.

required
Technology
technology		enum

Restrict this rule to a specific technology.

  • Go
  • Nodejs
  • PHP
  • Java
  • dotNet
optional
This API defines a third party library
thirdPartyApi		boolean-required
List of conditions
conditions		Set<apiRule>-required
The apiRule object
PropertyTypeDescriptionRequired
Base
base		enum
  • FQCN
  • FILE_NAME
  • PACKAGE
required
Matcher
matcher		enum
  • BEGINS_WITH
  • CONTAINS
required
Pattern
pattern		text-required