Contains entity definitions for PostgreSQL database entities stored in Smartscape on Grail. All PostgreSQL entity types are prefixed with DB_* and end in _POSTGRES.
Smartscape node name: db.database.name
Smartscape node type: DB_DATABASE_POSTGRES
A PostgreSQL database entity.
Fetch all PostgreSQL database entities.
smartscapeNodes DB_DATABASE_POSTGRES
Get databases and corresponding instances.
smartscapeEdges "runs_on"| filter matchesValue(source_type, "DB_DATABASE_POSTGRES") and matchesValue(target_type, "DB_INSTANCE_POSTGRES")| fields database_name=getNodeName(source_id), instance_name=getNodeName(target_id)
The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port, db.database.name
The following base fields are used for all entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
id | smartscapeId | stable Display name: IDA 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 | deprecated Display name: Classic IDThe 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 | stable Display name: NameThe entity name. | localhost; easyTravel; product-catalog |
type | string | stable Display name: TypeThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity. Tags: permission | TYPE_A |
tags | record | stable Display name: TagsA 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 | stable Display name: LifetimeThe 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 | stable Display name: ReferencesProvides 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 stable Display name: DT security contextThe security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission | [] |
Fields common to all entities within the databases model.
| Attribute | Type | Description | Examples |
|---|---|---|---|
db.connection_details.ip | ipAddress | experimental IP address of the listener to which Dynatrace is connected. | 10.100.10.10 |
db.connection_details.hostname | string | experimental Hostname of the listener Dynatrace is connected to. | my-database-server.myorg.org |
db.connection_details.port | string | experimental Port of the listener Dynatrace is connected to. | 5432 |
db.connection_details | string | experimental Listener connection details in the form <hostname>:<port>/<database>. | my-database-server.myorg.org:5432/testdb |
db.system | string | experimental Display name: Database systemAn 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 |
Fields that are common across all DB_DATABASE_* type nodes.
| Attribute | Type | Description | Examples |
|---|---|---|---|
db.database.name | string | experimental Name of the database. | testdb; PDB1 |
| Type | Target type | Kind | Description |
|---|---|---|---|
runs_on | DB_INSTANCE_POSTGRES | static | stable Defines 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. |
Smartscape node name: db.instance.name
Smartscape node type: DB_INSTANCE_POSTGRES
A PostgreSQL instance entity. Represents a physical server on which multiple databases can run.
Fetch all PostgreSQL instance entities.
smartscapeNodes DB_INSTANCE_POSTGRES
Count instances by their version.
smartscapeNodes DB_INSTANCE_POSTGRES| summarize count(), by: { db.instance.version }
The ID is calculated based on the following fields in the defined order: db.connection_details.hostname, db.connection_details.port
The following base fields are used for all entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
id | smartscapeId | stable Display name: IDA 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 | deprecated Display name: Classic IDThe 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 | stable Display name: NameThe entity name. | localhost; easyTravel; product-catalog |
type | string | stable Display name: TypeThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity. Tags: permission | TYPE_A |
tags | record | stable Display name: TagsA 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 | stable Display name: LifetimeThe 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 | stable Display name: ReferencesProvides 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 stable Display name: DT security contextThe security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission | [] |
Fields common to all entities within the databases model.
| Attribute | Type | Description | Examples |
|---|---|---|---|
db.connection_details.ip | ipAddress | experimental IP address of the listener to which Dynatrace is connected. | 10.100.10.10 |
db.connection_details.hostname | string | experimental Hostname of the listener Dynatrace is connected to. | my-database-server.myorg.org |
db.connection_details.port | string | experimental Port of the listener Dynatrace is connected to. | 5432 |
db.connection_details | string | experimental Listener connection details in the form <hostname>:<port>/<database>. | my-database-server.myorg.org:5432/testdb |
db.system | string | experimental Display name: Database systemAn 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 |
Fields that are common across all DB_INSTANCE_* type nodes.
| Attribute | Type | Description | Examples |
|---|---|---|---|
db.instance.name | string | experimental Name of the database instance. | my-database-server.myorg.org:5432; ORCLCDB1; MSSQLSERVER@EC2AMAZ-EV24GE8 |
db.instance.version | string | experimental Version 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 |
| Type | Target type | Kind | Description |
|---|---|---|---|
runs_on | HOST | static | stable Defines 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 | experimental Defines an equivalence relationship. Examples: A database instance is the same as a host process. |