Try it free

SAP HANA

  • Latest Dynatrace
  • Reference

Contains entity definitions for SAP HANA database entities stored in Smartscape on Grail. All HANA entity types are prefixed with DB_* and end in _HANA.

SAP HANA database

Smartscape node name: db.database.name

Smartscape node type: DB_DATABASE_HANA

A SAP HANA database entity.

Query

Fetch all SAP HANA database entities.

smartscapeNodes DB_DATABASE_HANA

Get databases and corresponding instances.

smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_DATABASE_HANA") and matchesValue(target_type, "DB_INSTANCE_HANA")
| 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: host.name, db.database.name, db.connection_details.port

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

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.

AttributeTypeDescriptionExamples

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.

ValueDescriptionDisplay 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 fields

Fields that are common across all DB_DATABASE_* type nodes.

AttributeTypeDescriptionExamples

db.database.name

string

experimentalName of the database.

testdb; PDB1

SAP HANA entity fields

Specific attributes for all SAP HANA entities

AttributeTypeDescriptionExamples

custom_host

string

experimentalCustom host name configured for the SAP HANA instance.

my-hana-host

host

string

experimentalHost name of the SAP HANA instance.

hana-server-01

host.name

string

resource experimentalHost name of the SAP HANA instance.Tags: permission

hana-server-01; my-hana-host

SAP HANA database fields

Specific attributes of SAP HANA database entity.

AttributeTypeDescriptionExamples

max_sessions

string

experimentalMaximum number of sessions allowed on the database.

1024

max_transactions

string

experimentalMaximum number of transactions allowed on the database.

512

replication_host

string

experimentalSecondary host name for system replication.

hana-standby-01

replication_status

string

experimentalStatus of the system replication.

ACTIVE; SYNCING; ERROR

replication_mode

string

experimentalMode of the system replication.

sync; syncmem; async

full_sync

string

experimentalIndicates whether full synchronization is enabled.

true; false

SAP HANA database relationships

TypeTarget typeKindDescription

runs_on

DB_INSTANCE_HANA

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.

SAP HANA instance

Smartscape node name: host.name

Smartscape node type: DB_INSTANCE_HANA

A SAP HANA instance entity. Represents a SAP HANA database host.

Query

Fetch all SAP HANA instance entities.

smartscapeNodes DB_INSTANCE_HANA

Count instances by their version.

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

ID input

The ID is calculated based on the following fields in the defined order: host.name

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

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.

AttributeTypeDescriptionExamples

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.

ValueDescriptionDisplay 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.

AttributeTypeDescriptionExamples

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

SAP HANA entity fields

Specific attributes for all SAP HANA entities

AttributeTypeDescriptionExamples

custom_host

string

experimentalCustom host name configured for the SAP HANA instance.

my-hana-host

host

string

experimentalHost name of the SAP HANA instance.

hana-server-01

host.name

string

resource experimentalHost name of the SAP HANA instance.Tags: permission

hana-server-01; my-hana-host

SAP HANA instance fields

Specific attributes of SAP HANA instance entity.

AttributeTypeDescriptionExamples

ip_addresses

string

experimentalIP addresses of the SAP HANA instance.

10.0.0.1

license_limit

string

experimentalLicensed memory limit of the SAP HANA instance.

128

license_id

string

experimentalLicense system identifier of the SAP HANA instance.

HDB

license_exp_date

string

experimentalLicense expiration date of the SAP HANA instance.

2026-12-31

license_valid

string

experimentalIndicates whether the SAP HANA license is valid.

true; false

SAP HANA instance relationships

TypeTarget typeKindDescription

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.

SAP HANA service

Smartscape node name: service_name

Smartscape node type: DB_SERVICE_HANA

A SAP HANA service entity. Represents a service running on a SAP HANA instance.

Query

Fetch all SAP HANA service entities.

smartscapeNodes DB_SERVICE_HANA

Get services and corresponding instances.

smartscapeEdges "runs_on"
| filter matchesValue(source_type, "DB_SERVICE_HANA") and matchesValue(target_type, "DB_INSTANCE_HANA")
| fields service_name=getNodeName(source_id), instance_name=getNodeName(target_id)

ID input

The ID is calculated based on the following fields in the defined order: host.name, service_name, port

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

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.

AttributeTypeDescriptionExamples

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.

ValueDescriptionDisplay 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

SAP HANA entity fields

Specific attributes for all SAP HANA entities

AttributeTypeDescriptionExamples

custom_host

string

experimentalCustom host name configured for the SAP HANA instance.

my-hana-host

host

string

experimentalHost name of the SAP HANA instance.

hana-server-01

host.name

string

resource experimentalHost name of the SAP HANA instance.Tags: permission

hana-server-01; my-hana-host

SAP HANA service fields

Specific attributes of SAP HANA service entity.

AttributeTypeDescriptionExamples

service_name

string

experimentalName of the SAP HANA service.

indexserver; nameserver; xsengine

port

string

experimentalPort of the SAP HANA service.

30003

sql_port

string

experimentalSQL port of the SAP HANA service.

30015

status

string

experimentalStatus of the SAP HANA service.

yes; no

SAP HANA service relationships

TypeTarget typeKindDescription

runs_on

DB_INSTANCE_HANA

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.

belongs_to

DB_DATABASE_HANA

static

stableThis is similar to an aggregation in UML. It is a many-to-many relationship without existential properties (the destination is not composed of the sources).

same_as

PROCESS

static

experimentalDefines an equivalence relationship. Examples: A database instance is the same as a host process.