SQL Server

Latest Dynatrace
Reference

Contains entity definitions for SQL Server database entities stored in Smartscape on Grail. All SQL Server entity types are prefixed with DB_* and end in _MSSQL.

SQL Server availability database

Smartscape node name: db.database.name

Smartscape node type: DB_AVAILABILITY_DATABASE_MSSQL

A SQL Server Always On availability database entity.

Query

Fetch all SQL Server availability database entities.

smartscapeNodes DB_AVAILABILITY_DATABASE_MSSQL

Get availability databases and corresponding replicas.

smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_AVAILABILITY_DATABASE_MSSQL") and matchesValue(target_type, "DB_AVAILABILITY_REPLICA_MSSQL")
| fields database_name=getNodeName(source_id), replica_name=getNodeName(target_id)

ID input

The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, availability_group_id, availability_replica_id, availability_database_id

Base entity fields

The following base fields are used for all entities.

Attribute	Type	Description	Examples
`id`	smartscapeId	stableA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs.	`<type>-017198AD253CBD63`
`id_classic`	string	deprecatedThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the `id` field instead, which is the Smartscape ID.	`<type>-017198AD253CBD63`
`name`	string	stableThe entity name.	`localhost`; `easyTravel`; `product-catalog`
`type`	string	stableThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity.	`TYPE_A`
`tags`	record	stableA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, `release` or `name`). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via `tags:context` field. Note that rule-based tags do not exist in the new model.	`tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]`; `tags[tag_key-2] = context_C_tag_val-1`; `tags:context_A[tag_key-1] = context_A_tag_val-1`
`lifetime`	timeframe	stableThe lifetime of the entity. This is a record with two nested fields: `start` and `end`, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time.	`{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }`
`references`	record	stableProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command.	`{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }`
`dt.security_context`	string[]	resource stableThe security contexts associated with the entity. For Smartscape entities, this field is always an array.Tags: `permission`	`[]`

Database entity fields

Fields common to all entities within the databases model.

Attribute	Type	Description	Examples
`db.connection_details.ip`	ipAddress	experimentalIP address of the listener to which Dynatrace is connected.	`10.100.10.10`
`db.connection_details.hostname`	string	experimentalHostname of the listener Dynatrace is connected to.	`my-database-server.myorg.org`
`db.connection_details.port`	string	experimentalPort of the listener Dynatrace is connected to.	`5432`
`db.connection_details`	string	experimentalListener connection details in the form `<hostname>:<port>/<database>`.	`my-database-server.myorg.org:5432/testdb`
`db.system`	string	experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.	`mongodb`; `mysql`

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Value	Description	Display name
`adabas`	Adabas (Adaptable Database System)	Adabas
`amazon-documentdb`	Amazon DocumentDB	DocumentDB
`aurora-mysql`	Amazon Aurora MySQL	Aurora MySQL
`aurora-postgresql`	Amazon Aurora PostgreSQL	Aurora PostgreSQL
`cache`	InterSystems Caché	InterSystems Caché
`cassandra`	Apache Cassandra	Cassandra
`clickhouse`	ClickHouse	ClickHouse
`cloudscape`	Cloudscape	Cloudscape
`cockroachdb`	CockroachDB	CockroachDB
`coldfusion`	ColdFusion IMQ	ColdFusion IMQ
`cosmosdb`	Microsoft Azure Cosmos DB	Cosmos DB
`couchbase`	Couchbase	Couchbase
`couchdb`	CouchDB	CouchDB
`databricks`	Databricks Data Platform	Databricks Data Platform
`db2`	IBM Db2	IBM Db2
`derby`	Apache Derby	Derby
`dl/i`	IBM DL/I	IBM DL/I
`dynamodb`	Amazon DynamoDB	DynamoDB
`edb`	EnterpriseDB	EnterpriseDB
`elasticsearch`	Elasticsearch	Elasticsearch
`filemaker`	FileMaker	FileMaker
`firebird`	Firebird	Firebird
`firstsql`	FirstSQL	FirstSQL
`geode`	Apache Geode	Geode
`h2`	H2	H2
`hanadb`	SAP HANA	SAP HANA
`hbase`	Apache HBase	HBase
`hive`	Apache Hive	Hive
`hsqldb`	HyperSQL DataBase	HSQLDB
`informix`	Informix	Informix
`ingres`	Ingres	Ingres
`instantdb`	InstantDB	InstantDB
`interbase`	InterBase	InterBase
`keyspaces-cassandra`	Amazon Keyspaces for Apache Cassandra	Keyspaces
`mariadb`	MariaDB	MariaDB
`maxdb`	SAP MaxDB	SAP MaxDB
`memcached`	Memcached	Memcached
`mongodb`	MongoDB	MongoDB
`mssql`	Microsoft SQL Server	SQL Server
`mssqlcompact`	Microsoft SQL Server Compact	SQL Server Compact
`mysql`	MySQL	MySQL
`neo4j`	Neo4j	Neo4j
`neptune`	Amazon Neptune	Neptune
`netezza`	Netezza	Netezza
`opensearch`	OpenSearch	OpenSearch
`oracle`	Oracle Database	Oracle
`other_sql`	Some other SQL database. Fallback only. See notes.	Other SQL
`pervasive`	Pervasive PSQL	Pervasive PSQL
`phoenix`	Apache Phoenix	Apache Phoenix
`pointbase`	PointBase	PointBase
`postgresql`	PostgreSQL	PostgreSQL
`progress`	Progress Database	Progress
`redis`	Redis	Redis
`redshift`	Amazon Redshift	Redshift
`snowflake`	Snowflake Data Platform	Snowflake Data Platform
`spanner`	Cloud Spanner	Cloud Spanner
`sqlite`	SQLite	SQLite
`sybase`	Sybase	Sybase
`teradata`	Teradata	Teradata
`valkey`	Valkey	Valkey
`vertica`	Vertica	Vertica

Database instance fields

Fields that are common across all DB_INSTANCE_* type nodes.

Attribute	Type	Description	Examples
`db.instance.name`	string	experimentalName of the database instance.	`my-database-server.myorg.org:5432`; `ORCLCDB1`; `MSSQLSERVER@EC2AMAZ-EV24GE8`
`db.instance.version`	string	experimentalVersion of the database instance as reported by the database vendor.	`21.0.0.0.0`; `16.10 (Debian 16.10-1.pgdg13+1)`; `14.15`

Database fields

Fields that are common across all DB_DATABASE_* type nodes.

Attribute	Type	Description	Examples
`db.database.name`	string	experimentalName of the database.	`testdb`; `PDB1`

SQL Server entity fields

Specific attributes for all SQL Server entities.

Attribute	Type	Description	Examples
`host.name`	string	resource experimentalName of the server hosting the SQL Server instance.Tags: `permission`	`EC2AMAZ-EV24GE8`

SQL Server availability entity fields

Specific attributes for all SQL Server Always On Availability entities.

Attribute	Type	Description	Examples
`synchronization_health`	string	experimentalSynchronization health of the specific entity.	`HEALTHY`; `PARTIALLY_HEALTHY`; `NOT_HEALTHY`

SQL Server availability database fields

Specific attributes of SQL Server availability database entity.

Attribute	Type	Description	Examples
`availability_database_id`	string	experimentalInternal SQL Server identifier of the availability database.	`6E345D91-E613-41D1-A58F-3A1B51A9A4A1`
`synchronization_state`	string	experimentalSynchronization state of the availability database.	`SYNCHRONIZING`; `SYNCHRONIZED`; `NOT_SYNCHRONIZING`

SQL Server availability database relationships

Type	Target type	Kind	Description
`runs_on`	`DB_AVAILABILITY_REPLICA_MSSQL`	static	stableDefines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.

SQL Server availability group

Smartscape node name: name

Smartscape node type: DB_AVAILABILITY_GROUP_MSSQL

A SQL Server Always On availability group entity.

Query

Fetch all SQL Server availability group entities.

smartscapeNodes DB_AVAILABILITY_GROUP_MSSQL

ID input

The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, availability_group_id

Base entity fields

The following base fields are used for all entities.

Attribute	Type	Description	Examples
`id`	smartscapeId	stableA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs.	`<type>-017198AD253CBD63`
`id_classic`	string	deprecatedThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the `id` field instead, which is the Smartscape ID.	`<type>-017198AD253CBD63`
`name`	string	stableThe entity name.	`localhost`; `easyTravel`; `product-catalog`
`type`	string	stableThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity.	`TYPE_A`
`tags`	record	stableA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, `release` or `name`). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via `tags:context` field. Note that rule-based tags do not exist in the new model.	`tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]`; `tags[tag_key-2] = context_C_tag_val-1`; `tags:context_A[tag_key-1] = context_A_tag_val-1`
`lifetime`	timeframe	stableThe lifetime of the entity. This is a record with two nested fields: `start` and `end`, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time.	`{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }`
`references`	record	stableProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command.	`{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }`
`dt.security_context`	string[]	resource stableThe security contexts associated with the entity. For Smartscape entities, this field is always an array.Tags: `permission`	`[]`

Database entity fields

Fields common to all entities within the databases model.

Attribute	Type	Description	Examples
`db.connection_details.ip`	ipAddress	experimentalIP address of the listener to which Dynatrace is connected.	`10.100.10.10`
`db.connection_details.hostname`	string	experimentalHostname of the listener Dynatrace is connected to.	`my-database-server.myorg.org`
`db.connection_details.port`	string	experimentalPort of the listener Dynatrace is connected to.	`5432`
`db.connection_details`	string	experimentalListener connection details in the form `<hostname>:<port>/<database>`.	`my-database-server.myorg.org:5432/testdb`
`db.system`	string	experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.	`mongodb`; `mysql`

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Value	Description	Display name
`adabas`	Adabas (Adaptable Database System)	Adabas
`amazon-documentdb`	Amazon DocumentDB	DocumentDB
`aurora-mysql`	Amazon Aurora MySQL	Aurora MySQL
`aurora-postgresql`	Amazon Aurora PostgreSQL	Aurora PostgreSQL
`cache`	InterSystems Caché	InterSystems Caché
`cassandra`	Apache Cassandra	Cassandra
`clickhouse`	ClickHouse	ClickHouse
`cloudscape`	Cloudscape	Cloudscape
`cockroachdb`	CockroachDB	CockroachDB
`coldfusion`	ColdFusion IMQ	ColdFusion IMQ
`cosmosdb`	Microsoft Azure Cosmos DB	Cosmos DB
`couchbase`	Couchbase	Couchbase
`couchdb`	CouchDB	CouchDB
`databricks`	Databricks Data Platform	Databricks Data Platform
`db2`	IBM Db2	IBM Db2
`derby`	Apache Derby	Derby
`dl/i`	IBM DL/I	IBM DL/I
`dynamodb`	Amazon DynamoDB	DynamoDB
`edb`	EnterpriseDB	EnterpriseDB
`elasticsearch`	Elasticsearch	Elasticsearch
`filemaker`	FileMaker	FileMaker
`firebird`	Firebird	Firebird
`firstsql`	FirstSQL	FirstSQL
`geode`	Apache Geode	Geode
`h2`	H2	H2
`hanadb`	SAP HANA	SAP HANA
`hbase`	Apache HBase	HBase
`hive`	Apache Hive	Hive
`hsqldb`	HyperSQL DataBase	HSQLDB
`informix`	Informix	Informix
`ingres`	Ingres	Ingres
`instantdb`	InstantDB	InstantDB
`interbase`	InterBase	InterBase
`keyspaces-cassandra`	Amazon Keyspaces for Apache Cassandra	Keyspaces
`mariadb`	MariaDB	MariaDB
`maxdb`	SAP MaxDB	SAP MaxDB
`memcached`	Memcached	Memcached
`mongodb`	MongoDB	MongoDB
`mssql`	Microsoft SQL Server	SQL Server
`mssqlcompact`	Microsoft SQL Server Compact	SQL Server Compact
`mysql`	MySQL	MySQL
`neo4j`	Neo4j	Neo4j
`neptune`	Amazon Neptune	Neptune
`netezza`	Netezza	Netezza
`opensearch`	OpenSearch	OpenSearch
`oracle`	Oracle Database	Oracle
`other_sql`	Some other SQL database. Fallback only. See notes.	Other SQL
`pervasive`	Pervasive PSQL	Pervasive PSQL
`phoenix`	Apache Phoenix	Apache Phoenix
`pointbase`	PointBase	PointBase
`postgresql`	PostgreSQL	PostgreSQL
`progress`	Progress Database	Progress
`redis`	Redis	Redis
`redshift`	Amazon Redshift	Redshift
`snowflake`	Snowflake Data Platform	Snowflake Data Platform
`spanner`	Cloud Spanner	Cloud Spanner
`sqlite`	SQLite	SQLite
`sybase`	Sybase	Sybase
`teradata`	Teradata	Teradata
`valkey`	Valkey	Valkey
`vertica`	Vertica	Vertica

SQL Server entity fields

Specific attributes for all SQL Server entities.

Attribute	Type	Description	Examples
`host.name`	string	resource experimentalName of the server hosting the SQL Server instance.Tags: `permission`	`EC2AMAZ-EV24GE8`

SQL Server availability entity fields

Specific attributes for all SQL Server Always On Availability entities.

Attribute	Type	Description	Examples
`synchronization_health`	string	experimentalSynchronization health of the specific entity.	`HEALTHY`; `PARTIALLY_HEALTHY`; `NOT_HEALTHY`

SQL Server availability group fields

Specific attributes of SQL Server availability group entity

Attribute	Type	Description	Examples
`availability_group_id`	string	experimentalInternal SQL Server identifier of the availability group.	`6E345D91-E613-41D1-A58F-3A1B51A9A4A1`
`backup_preference`	string	experimentalAutomated backup preference of the availability group.	`PRIMARY`; `SECONDARY_ONLY`; `SECONDARY`; `NONE`
`primary_recovery_health`	string	experimentalRecovery health of the primary replica.	`ONLINE`; `OFFLINE`
`secondary_recovery_health`	string	experimentalRecovery health of the secondary replica.	`ONLINE`; `OFFLINE`

SQL Server availability replica

Smartscape node name: host.name

Smartscape node type: DB_AVAILABILITY_REPLICA_MSSQL

A SQL Server Always On availability replica entity.

Query

Fetch all SQL Server availability replica entities.

smartscapeNodes DB_AVAILABILITY_REPLICA_MSSQL

Get availability replicas and corresponding availability groups.

smartscapeEdges "is_part_of"
| filter matchesValue(source_type, "DB_AVAILABILITY_REPLICA_MSSQL") and matchesValue(target_type, "DB_AVAILABILITY_GROUP_MSSQL")
| fields replica_name=getNodeName(source_id), group_name=getNodeName(target_id)

ID input

The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, availability_group_id, availability_replica_id

Base entity fields

The following base fields are used for all entities.

Attribute	Type	Description	Examples
`id`	smartscapeId	stableA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs.	`<type>-017198AD253CBD63`
`id_classic`	string	deprecatedThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the `id` field instead, which is the Smartscape ID.	`<type>-017198AD253CBD63`
`name`	string	stableThe entity name.	`localhost`; `easyTravel`; `product-catalog`
`type`	string	stableThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity.	`TYPE_A`
`tags`	record	stableA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, `release` or `name`). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via `tags:context` field. Note that rule-based tags do not exist in the new model.	`tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]`; `tags[tag_key-2] = context_C_tag_val-1`; `tags:context_A[tag_key-1] = context_A_tag_val-1`
`lifetime`	timeframe	stableThe lifetime of the entity. This is a record with two nested fields: `start` and `end`, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time.	`{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }`
`references`	record	stableProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command.	`{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }`
`dt.security_context`	string[]	resource stableThe security contexts associated with the entity. For Smartscape entities, this field is always an array.Tags: `permission`	`[]`

Database entity fields

Fields common to all entities within the databases model.

Attribute	Type	Description	Examples
`db.connection_details.ip`	ipAddress	experimentalIP address of the listener to which Dynatrace is connected.	`10.100.10.10`
`db.connection_details.hostname`	string	experimentalHostname of the listener Dynatrace is connected to.	`my-database-server.myorg.org`
`db.connection_details.port`	string	experimentalPort of the listener Dynatrace is connected to.	`5432`
`db.connection_details`	string	experimentalListener connection details in the form `<hostname>:<port>/<database>`.	`my-database-server.myorg.org:5432/testdb`
`db.system`	string	experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.	`mongodb`; `mysql`

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Value	Description	Display name
`adabas`	Adabas (Adaptable Database System)	Adabas
`amazon-documentdb`	Amazon DocumentDB	DocumentDB
`aurora-mysql`	Amazon Aurora MySQL	Aurora MySQL
`aurora-postgresql`	Amazon Aurora PostgreSQL	Aurora PostgreSQL
`cache`	InterSystems Caché	InterSystems Caché
`cassandra`	Apache Cassandra	Cassandra
`clickhouse`	ClickHouse	ClickHouse
`cloudscape`	Cloudscape	Cloudscape
`cockroachdb`	CockroachDB	CockroachDB
`coldfusion`	ColdFusion IMQ	ColdFusion IMQ
`cosmosdb`	Microsoft Azure Cosmos DB	Cosmos DB
`couchbase`	Couchbase	Couchbase
`couchdb`	CouchDB	CouchDB
`databricks`	Databricks Data Platform	Databricks Data Platform
`db2`	IBM Db2	IBM Db2
`derby`	Apache Derby	Derby
`dl/i`	IBM DL/I	IBM DL/I
`dynamodb`	Amazon DynamoDB	DynamoDB
`edb`	EnterpriseDB	EnterpriseDB
`elasticsearch`	Elasticsearch	Elasticsearch
`filemaker`	FileMaker	FileMaker
`firebird`	Firebird	Firebird
`firstsql`	FirstSQL	FirstSQL
`geode`	Apache Geode	Geode
`h2`	H2	H2
`hanadb`	SAP HANA	SAP HANA
`hbase`	Apache HBase	HBase
`hive`	Apache Hive	Hive
`hsqldb`	HyperSQL DataBase	HSQLDB
`informix`	Informix	Informix
`ingres`	Ingres	Ingres
`instantdb`	InstantDB	InstantDB
`interbase`	InterBase	InterBase
`keyspaces-cassandra`	Amazon Keyspaces for Apache Cassandra	Keyspaces
`mariadb`	MariaDB	MariaDB
`maxdb`	SAP MaxDB	SAP MaxDB
`memcached`	Memcached	Memcached
`mongodb`	MongoDB	MongoDB
`mssql`	Microsoft SQL Server	SQL Server
`mssqlcompact`	Microsoft SQL Server Compact	SQL Server Compact
`mysql`	MySQL	MySQL
`neo4j`	Neo4j	Neo4j
`neptune`	Amazon Neptune	Neptune
`netezza`	Netezza	Netezza
`opensearch`	OpenSearch	OpenSearch
`oracle`	Oracle Database	Oracle
`other_sql`	Some other SQL database. Fallback only. See notes.	Other SQL
`pervasive`	Pervasive PSQL	Pervasive PSQL
`phoenix`	Apache Phoenix	Apache Phoenix
`pointbase`	PointBase	PointBase
`postgresql`	PostgreSQL	PostgreSQL
`progress`	Progress Database	Progress
`redis`	Redis	Redis
`redshift`	Amazon Redshift	Redshift
`snowflake`	Snowflake Data Platform	Snowflake Data Platform
`spanner`	Cloud Spanner	Cloud Spanner
`sqlite`	SQLite	SQLite
`sybase`	Sybase	Sybase
`teradata`	Teradata	Teradata
`valkey`	Valkey	Valkey
`vertica`	Vertica	Vertica

Database instance fields

Fields that are common across all DB_INSTANCE_* type nodes.

Attribute	Type	Description	Examples
`db.instance.name`	string	experimentalName of the database instance.	`my-database-server.myorg.org:5432`; `ORCLCDB1`; `MSSQLSERVER@EC2AMAZ-EV24GE8`
`db.instance.version`	string	experimentalVersion of the database instance as reported by the database vendor.	`21.0.0.0.0`; `16.10 (Debian 16.10-1.pgdg13+1)`; `14.15`

SQL Server entity fields

Specific attributes for all SQL Server entities.

Attribute	Type	Description	Examples
`host.name`	string	resource experimentalName of the server hosting the SQL Server instance.Tags: `permission`	`EC2AMAZ-EV24GE8`

SQL Server availability entity fields

Specific attributes for all SQL Server Always On Availability entities.

Attribute	Type	Description	Examples
`synchronization_health`	string	experimentalSynchronization health of the specific entity.	`HEALTHY`; `PARTIALLY_HEALTHY`; `NOT_HEALTHY`

SQL Server availability replica fields

Specific attributes of SQL Server availability replica entity.

Attribute	Type	Description	Examples
`availability_replica_id`	string	experimentalInternal SQL Server identifier of the availability replica.	`6E345D91-E613-41D1-A58F-3A1B51A9A4A1`
`availability_mode`	string	experimentalAvailability mode of the replica.	`SYNCHRONOUS_COMMIT`; `ASYNCHRONOUS_COMMIT`
`failover_mode`	string	experimentalFailover mode of the replica.	`AUTOMATIC`; `MANUAL`
`is_local`	string	experimentalIndicates whether the replica is local.	`1`; `0`
`operational_state`	string	experimentalOperational state of the replica.	`ONLINE`; `OFFLINE`; `PENDING`; `FAILED`
`recovery_health`	string	experimentalRecovery health of the replica.	`ONLINE`; `OFFLINE`
`connected_state`	string	experimentalConnected state of the replica.	`CONNECTED`; `DISCONNECTED`
`role`	string	experimentalCurrent role of the replica.	`PRIMARY`; `SECONDARY`; `RESOLVING`

SQL Server availability replica relationships

Type	Target type	Kind	Description
`is_part_of`	`DB_AVAILABILITY_GROUP_MSSQL`	static	stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).
`same_as`	`DB_INSTANCE_MSSQL`	static	experimentalDefines an equivalence relationship. Examples: A database instance is the same as a host process.

SQL Server database

Smartscape node name: db.database.name

Smartscape node type: DB_DATABASE_MSSQL

A SQL Server database entity.

Query

Fetch all SQL Server database entities.

smartscapeNodes DB_DATABASE_MSSQL

Get databases and corresponding instances.

smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_MSSQL") and matchesValue(target_type, "DB_INSTANCE_MSSQL")
| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)

ID input

The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, host.name, db.instance.name, db.database.name

Base entity fields

The following base fields are used for all entities.

Attribute	Type	Description	Examples
`id`	smartscapeId	stableA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs.	`<type>-017198AD253CBD63`
`id_classic`	string	deprecatedThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the `id` field instead, which is the Smartscape ID.	`<type>-017198AD253CBD63`
`name`	string	stableThe entity name.	`localhost`; `easyTravel`; `product-catalog`
`type`	string	stableThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity.	`TYPE_A`
`tags`	record	stableA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, `release` or `name`). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via `tags:context` field. Note that rule-based tags do not exist in the new model.	`tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]`; `tags[tag_key-2] = context_C_tag_val-1`; `tags:context_A[tag_key-1] = context_A_tag_val-1`
`lifetime`	timeframe	stableThe lifetime of the entity. This is a record with two nested fields: `start` and `end`, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time.	`{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }`
`references`	record	stableProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command.	`{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }`
`dt.security_context`	string[]	resource stableThe security contexts associated with the entity. For Smartscape entities, this field is always an array.Tags: `permission`	`[]`

Database entity fields

Fields common to all entities within the databases model.

Attribute	Type	Description	Examples
`db.connection_details.ip`	ipAddress	experimentalIP address of the listener to which Dynatrace is connected.	`10.100.10.10`
`db.connection_details.hostname`	string	experimentalHostname of the listener Dynatrace is connected to.	`my-database-server.myorg.org`
`db.connection_details.port`	string	experimentalPort of the listener Dynatrace is connected to.	`5432`
`db.connection_details`	string	experimentalListener connection details in the form `<hostname>:<port>/<database>`.	`my-database-server.myorg.org:5432/testdb`
`db.system`	string	experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.	`mongodb`; `mysql`

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Value	Description	Display name
`adabas`	Adabas (Adaptable Database System)	Adabas
`amazon-documentdb`	Amazon DocumentDB	DocumentDB
`aurora-mysql`	Amazon Aurora MySQL	Aurora MySQL
`aurora-postgresql`	Amazon Aurora PostgreSQL	Aurora PostgreSQL
`cache`	InterSystems Caché	InterSystems Caché
`cassandra`	Apache Cassandra	Cassandra
`clickhouse`	ClickHouse	ClickHouse
`cloudscape`	Cloudscape	Cloudscape
`cockroachdb`	CockroachDB	CockroachDB
`coldfusion`	ColdFusion IMQ	ColdFusion IMQ
`cosmosdb`	Microsoft Azure Cosmos DB	Cosmos DB
`couchbase`	Couchbase	Couchbase
`couchdb`	CouchDB	CouchDB
`databricks`	Databricks Data Platform	Databricks Data Platform
`db2`	IBM Db2	IBM Db2
`derby`	Apache Derby	Derby
`dl/i`	IBM DL/I	IBM DL/I
`dynamodb`	Amazon DynamoDB	DynamoDB
`edb`	EnterpriseDB	EnterpriseDB
`elasticsearch`	Elasticsearch	Elasticsearch
`filemaker`	FileMaker	FileMaker
`firebird`	Firebird	Firebird
`firstsql`	FirstSQL	FirstSQL
`geode`	Apache Geode	Geode
`h2`	H2	H2
`hanadb`	SAP HANA	SAP HANA
`hbase`	Apache HBase	HBase
`hive`	Apache Hive	Hive
`hsqldb`	HyperSQL DataBase	HSQLDB
`informix`	Informix	Informix
`ingres`	Ingres	Ingres
`instantdb`	InstantDB	InstantDB
`interbase`	InterBase	InterBase
`keyspaces-cassandra`	Amazon Keyspaces for Apache Cassandra	Keyspaces
`mariadb`	MariaDB	MariaDB
`maxdb`	SAP MaxDB	SAP MaxDB
`memcached`	Memcached	Memcached
`mongodb`	MongoDB	MongoDB
`mssql`	Microsoft SQL Server	SQL Server
`mssqlcompact`	Microsoft SQL Server Compact	SQL Server Compact
`mysql`	MySQL	MySQL
`neo4j`	Neo4j	Neo4j
`neptune`	Amazon Neptune	Neptune
`netezza`	Netezza	Netezza
`opensearch`	OpenSearch	OpenSearch
`oracle`	Oracle Database	Oracle
`other_sql`	Some other SQL database. Fallback only. See notes.	Other SQL
`pervasive`	Pervasive PSQL	Pervasive PSQL
`phoenix`	Apache Phoenix	Apache Phoenix
`pointbase`	PointBase	PointBase
`postgresql`	PostgreSQL	PostgreSQL
`progress`	Progress Database	Progress
`redis`	Redis	Redis
`redshift`	Amazon Redshift	Redshift
`snowflake`	Snowflake Data Platform	Snowflake Data Platform
`spanner`	Cloud Spanner	Cloud Spanner
`sqlite`	SQLite	SQLite
`sybase`	Sybase	Sybase
`teradata`	Teradata	Teradata
`valkey`	Valkey	Valkey
`vertica`	Vertica	Vertica

Database instance fields

Fields that are common across all DB_INSTANCE_* type nodes.

Attribute	Type	Description	Examples
`db.instance.name`	string	experimentalName of the database instance.	`my-database-server.myorg.org:5432`; `ORCLCDB1`; `MSSQLSERVER@EC2AMAZ-EV24GE8`
`db.instance.version`	string	experimentalVersion of the database instance as reported by the database vendor.	`21.0.0.0.0`; `16.10 (Debian 16.10-1.pgdg13+1)`; `14.15`

Database fields

Fields that are common across all DB_DATABASE_* type nodes.

Attribute	Type	Description	Examples
`db.database.name`	string	experimentalName of the database.	`testdb`; `PDB1`

SQL Server entity fields

Specific attributes for all SQL Server entities.

Attribute	Type	Description	Examples
`host.name`	string	resource experimentalName of the server hosting the SQL Server instance.Tags: `permission`	`EC2AMAZ-EV24GE8`

SQL Server database fields

Specific attributes of SQL Server database entity

Attribute	Type	Description	Examples
`recovery_model`	string	experimentalRecovery model of the database.	`FULL`; `SIMPLE`; `BULK_LOGGED`
`user_access`	string	experimentalUser access mode of the database.	`MULTI_USER`; `SINGLE_USER`; `RESTRICTED_USER`
`updateability`	string	experimentalUpdateability of the database.	`READ_WRITE`; `READ_ONLY`

SQL Server database relationships

Type	Target type	Kind	Description
`runs_on`	`DB_INSTANCE_MSSQL`	static	stableDefines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.

SQL Server instance

Smartscape node name: db.instance.name

Smartscape node type: DB_INSTANCE_MSSQL

A SQL Server instance entity. Represents a physical server on which multiple databases can run.

Query

Fetch all SQL Server instance entities.

smartscapeNodes DB_INSTANCE_MSSQL

Count instances by their version.

smartscapeNodes DB_INSTANCE_MSSQL
| summarize count(), by: { db.instance.version }

ID input

The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, host.name, db.instance.name

Base entity fields

The following base fields are used for all entities.

Attribute	Type	Description	Examples
`id`	smartscapeId	stableA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs.	`<type>-017198AD253CBD63`
`id_classic`	string	deprecatedThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the `id` field instead, which is the Smartscape ID.	`<type>-017198AD253CBD63`
`name`	string	stableThe entity name.	`localhost`; `easyTravel`; `product-catalog`
`type`	string	stableThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity.	`TYPE_A`
`tags`	record	stableA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, `release` or `name`). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via `tags:context` field. Note that rule-based tags do not exist in the new model.	`tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]`; `tags[tag_key-2] = context_C_tag_val-1`; `tags:context_A[tag_key-1] = context_A_tag_val-1`
`lifetime`	timeframe	stableThe lifetime of the entity. This is a record with two nested fields: `start` and `end`, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time.	`{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }`
`references`	record	stableProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command.	`{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }`
`dt.security_context`	string[]	resource stableThe security contexts associated with the entity. For Smartscape entities, this field is always an array.Tags: `permission`	`[]`

Database entity fields

Fields common to all entities within the databases model.

Attribute	Type	Description	Examples
`db.connection_details.ip`	ipAddress	experimentalIP address of the listener to which Dynatrace is connected.	`10.100.10.10`
`db.connection_details.hostname`	string	experimentalHostname of the listener Dynatrace is connected to.	`my-database-server.myorg.org`
`db.connection_details.port`	string	experimentalPort of the listener Dynatrace is connected to.	`5432`
`db.connection_details`	string	experimentalListener connection details in the form `<hostname>:<port>/<database>`.	`my-database-server.myorg.org:5432/testdb`
`db.system`	string	experimentalAn identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.	`mongodb`; `mysql`

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Value	Description	Display name
`adabas`	Adabas (Adaptable Database System)	Adabas
`amazon-documentdb`	Amazon DocumentDB	DocumentDB
`aurora-mysql`	Amazon Aurora MySQL	Aurora MySQL
`aurora-postgresql`	Amazon Aurora PostgreSQL	Aurora PostgreSQL
`cache`	InterSystems Caché	InterSystems Caché
`cassandra`	Apache Cassandra	Cassandra
`clickhouse`	ClickHouse	ClickHouse
`cloudscape`	Cloudscape	Cloudscape
`cockroachdb`	CockroachDB	CockroachDB
`coldfusion`	ColdFusion IMQ	ColdFusion IMQ
`cosmosdb`	Microsoft Azure Cosmos DB	Cosmos DB
`couchbase`	Couchbase	Couchbase
`couchdb`	CouchDB	CouchDB
`databricks`	Databricks Data Platform	Databricks Data Platform
`db2`	IBM Db2	IBM Db2
`derby`	Apache Derby	Derby
`dl/i`	IBM DL/I	IBM DL/I
`dynamodb`	Amazon DynamoDB	DynamoDB
`edb`	EnterpriseDB	EnterpriseDB
`elasticsearch`	Elasticsearch	Elasticsearch
`filemaker`	FileMaker	FileMaker
`firebird`	Firebird	Firebird
`firstsql`	FirstSQL	FirstSQL
`geode`	Apache Geode	Geode
`h2`	H2	H2
`hanadb`	SAP HANA	SAP HANA
`hbase`	Apache HBase	HBase
`hive`	Apache Hive	Hive
`hsqldb`	HyperSQL DataBase	HSQLDB
`informix`	Informix	Informix
`ingres`	Ingres	Ingres
`instantdb`	InstantDB	InstantDB
`interbase`	InterBase	InterBase
`keyspaces-cassandra`	Amazon Keyspaces for Apache Cassandra	Keyspaces
`mariadb`	MariaDB	MariaDB
`maxdb`	SAP MaxDB	SAP MaxDB
`memcached`	Memcached	Memcached
`mongodb`	MongoDB	MongoDB
`mssql`	Microsoft SQL Server	SQL Server
`mssqlcompact`	Microsoft SQL Server Compact	SQL Server Compact
`mysql`	MySQL	MySQL
`neo4j`	Neo4j	Neo4j
`neptune`	Amazon Neptune	Neptune
`netezza`	Netezza	Netezza
`opensearch`	OpenSearch	OpenSearch
`oracle`	Oracle Database	Oracle
`other_sql`	Some other SQL database. Fallback only. See notes.	Other SQL
`pervasive`	Pervasive PSQL	Pervasive PSQL
`phoenix`	Apache Phoenix	Apache Phoenix
`pointbase`	PointBase	PointBase
`postgresql`	PostgreSQL	PostgreSQL
`progress`	Progress Database	Progress
`redis`	Redis	Redis
`redshift`	Amazon Redshift	Redshift
`snowflake`	Snowflake Data Platform	Snowflake Data Platform
`spanner`	Cloud Spanner	Cloud Spanner
`sqlite`	SQLite	SQLite
`sybase`	Sybase	Sybase
`teradata`	Teradata	Teradata
`valkey`	Valkey	Valkey
`vertica`	Vertica	Vertica

Database instance fields

Fields that are common across all DB_INSTANCE_* type nodes.

Attribute	Type	Description	Examples
`db.instance.name`	string	experimentalName of the database instance.	`my-database-server.myorg.org:5432`; `ORCLCDB1`; `MSSQLSERVER@EC2AMAZ-EV24GE8`
`db.instance.version`	string	experimentalVersion of the database instance as reported by the database vendor.	`21.0.0.0.0`; `16.10 (Debian 16.10-1.pgdg13+1)`; `14.15`

SQL Server entity fields

Specific attributes for all SQL Server entities.

Attribute	Type	Description	Examples
`host.name`	string	resource experimentalName of the server hosting the SQL Server instance.Tags: `permission`	`EC2AMAZ-EV24GE8`

SQL Server instance fields

Specific attributes of SQL Server instance entity

Attribute	Type	Description	Examples
`edition`	string	experimentalEdition of the SQL Server instance.	`Enterprise Edition (64-bit)`; `Standard Edition (64-bit)`; `Express Edition (64-bit)`
`major_version`	string	experimentalMajor version number of the SQL Server instance.	`16`; `15`; `14`
`fully_qualified_server_name`	string	experimentalFully qualified name of the server hosting the SQL Server instance.	`EC2AMAZ-EV24GE8.example.com`
`affinity_type`	string	experimentalCPU affinity type of the SQL Server instance.	`0`; `1`
`cpu_count`	string	experimentalNumber of CPUs available to the SQL Server instance.	`4`; `8`
`physical_memory`	string	experimentalAmount of physical memory available to the SQL Server instance in MB.	`16384`; `32768`
`hyperthread_ratio`	string	experimentalHyperthread ratio of the SQL Server instance.	`2`
`virtual_machine_type`	string	experimentalVirtual machine type of the SQL Server instance.	`NONE`; `HYPERVISOR`
`start_time`	timestamp	stableStart time of the SQL Server instance.	`2024-01-15 08:30:00`

SQL Server instance relationships

Type	Target type	Kind	Description
`runs_on`	`HOST`	static	stableDefines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
`same_as`	`PROCESS`	static	experimentalDefines an equivalence relationship. Examples: A database instance is the same as a host process.