Try it free

Amazon Relational Database Service

  • Latest Dynatrace
  • Reference

Amazon Relational Database Service resource types in Smartscape on Grail

Amazon Relational Database Service DB cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBCLUSTER

This entity represents an Amazon Relational Database Service DB cluster, an Amazon Aurora DB cluster, an Amazon Neptune DB cluster or an Amazon DocumentDB DB cluster (filter the specific engine by db.system attribute).

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_DBCLUSTER"

smartscapeNodes "AWS_RDS_DBCLUSTER"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

AWS Zonal resource fields

Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.

AttributeTypeDescriptionExamples

aws.availability_zone

string

resource stable
Display name: Availability zone
A specific availability zone or array of zones in given AWS region.

us-east-1a; us-east-1b

Amazon Relational Database Service DB cluster fields

AttributeTypeDescriptionExamples

db.system

string

experimental
Display name: Database system
An 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

Amazon Relational Database Service DB cluster relationships

TypeTarget typeKindDescription

uses

AWS_EC2_SECURITYGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_RDS_DBSUBNETGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_KEY

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_ALIAS

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

runs_on

AWS_AVAILABILITY_ZONE

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.

Amazon Relational Database Service DB cluster snapshot

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBCLUSTERSNAPSHOT

This entity represents an Amazon Relational Database Service DB cluster snapshot, an Amazon Aurora DB cluster snapshot, an Amazon Neptune DB cluster snapshot or an Amazon DocumentDB DB cluster snapshot (filter the specific engine by db.system attribute).

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_DBCLUSTERSNAPSHOT"

smartscapeNodes "AWS_RDS_DBCLUSTERSNAPSHOT"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

AWS VPC attached resource fields

Contains all fields that are provided by VPC-attached AWS entities.

AttributeTypeDescriptionExamples

aws.vpc.id

string

experimental
Display name: AWS VPC ID
Assigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimental
Display name: AWS subnet ID
Assigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimental
Display name: AWS security group ID
Assigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Relational Database Service DB cluster snapshot fields

AttributeTypeDescriptionExamples

db.system

string

experimental
Display name: Database system
An 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

Amazon Relational Database Service DB cluster snapshot relationships

TypeTarget typeKindDescription

is_part_of

AWS_RDS_DBCLUSTER

static

stable
Defines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).

is_attached_to

AWS_EC2_VPC

static

stable
Is (typically) exclusively attached to the instance (1-many)

uses

AWS_KMS_KEY

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_ALIAS

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

Amazon Relational Database Service DB instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBINSTANCE

This entity represents an Amazon Relational Database Service DB instance, an Amazon Aurora DB instance, an Amazon Neptune DB instance or an Amazon DocumentDB DB instance (filter the specific engine by db.system attribute).

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_DBINSTANCE"

smartscapeNodes "AWS_RDS_DBINSTANCE"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

AWS VPC attached resource fields

Contains all fields that are provided by VPC-attached AWS entities.

AttributeTypeDescriptionExamples

aws.vpc.id

string

experimental
Display name: AWS VPC ID
Assigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimental
Display name: AWS subnet ID
Assigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimental
Display name: AWS security group ID
Assigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Zonal resource fields

Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.

AttributeTypeDescriptionExamples

aws.availability_zone

string

resource stable
Display name: Availability zone
A specific availability zone or array of zones in given AWS region.

us-east-1a; us-east-1b

Amazon Relational Database Service DB instance fields

AttributeTypeDescriptionExamples

db.system

string

experimental
Display name: Database system
An 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

Amazon Relational Database Service DB instance relationships

TypeTarget typeKindDescription

uses

AWS_EC2_SECURITYGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_RDS_DBSUBNETGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_RDS_OPTIONGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_KEY

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_ALIAS

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

is_attached_to

AWS_EC2_VPC

static

stable
Is (typically) exclusively attached to the instance (1-many)

is_attached_to

AWS_EC2_SUBNET

static

stable
Is (typically) exclusively attached to the instance (1-many)

is_part_of

AWS_RDS_DBCLUSTER

static

stable
Defines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).

runs_on

AWS_AVAILABILITY_ZONE

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.

Amazon Relational Database Service DB snapshot

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBSNAPSHOT

This entity represents an Amazon Relational Database Service DB snapshot, an Amazon Aurora DB snapshot, an Amazon Neptune DB snapshot or an Amazon DocumentDB DB snapshot (filter the specific engine by db.system attribute).

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_DBSNAPSHOT"

smartscapeNodes "AWS_RDS_DBSNAPSHOT"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

AWS VPC attached resource fields

Contains all fields that are provided by VPC-attached AWS entities.

AttributeTypeDescriptionExamples

aws.vpc.id

string

experimental
Display name: AWS VPC ID
Assigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimental
Display name: AWS subnet ID
Assigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimental
Display name: AWS security group ID
Assigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Zonal resource fields

Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.

AttributeTypeDescriptionExamples

aws.availability_zone

string

resource stable
Display name: Availability zone
A specific availability zone or array of zones in given AWS region.

us-east-1a; us-east-1b

Amazon Relational Database Service DB snapshot fields

AttributeTypeDescriptionExamples

db.system

string

experimental
Display name: Database system
An 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

Amazon Relational Database Service DB snapshot relationships

TypeTarget typeKindDescription

is_part_of

AWS_RDS_DBINSTANCE

static

stable
Defines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).

is_attached_to

AWS_EC2_VPC

static

stable
Is (typically) exclusively attached to the instance (1-many)

uses

AWS_RDS_OPTIONGROUP

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_KEY

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

uses

AWS_KMS_ALIAS

static

stable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

runs_on

AWS_AVAILABILITY_ZONE

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.

Amazon Relational Database Service DB subnet group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBSUBNETGROUP

This entity represents an Amazon Relational Database Service (RDS) DB subnet group.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_DBSUBNETGROUP"

smartscapeNodes "AWS_RDS_DBSUBNETGROUP"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

AWS VPC attached resource fields

Contains all fields that are provided by VPC-attached AWS entities.

AttributeTypeDescriptionExamples

aws.vpc.id

string

experimental
Display name: AWS VPC ID
Assigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimental
Display name: AWS subnet ID
Assigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimental
Display name: AWS security group ID
Assigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Relational Database Service DB subnet group relationships

TypeTarget typeKindDescription

is_attached_to

AWS_EC2_VPC

static

stable
Is (typically) exclusively attached to the instance (1-many)

is_attached_to

AWS_EC2_SUBNET

static

stable
Is (typically) exclusively attached to the instance (1-many)

Amazon Relational Database Service option group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_OPTIONGROUP

This entity represents an Amazon Relational Database Service (RDS) option group.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_RDS_OPTIONGROUP"

smartscapeNodes "AWS_RDS_OPTIONGROUP"

ID input

The ID is calculated based on the following fields in the defined order: aws.arn

Base entity fields

The following base fields are used for all entities.

AttributeTypeDescriptionExamples

id

smartscapeId

stable
Display name: ID
A 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 ID
The 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: Name
The entity name.

localhost; easyTravel; product-catalog

type

string

stable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.

TYPE_A

tags

record

stable
Display name: Tags
A 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: Lifetime
The 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: References
Provides 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 context
The security contexts associated with the entity. For Smartscape entities, this field is always an array.
Tags: permission

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.

OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples

aws.object

string

stable
Display name: AWS object
The full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimental
Display name: AWS properties version
The aws.object json content version

1.0

aws.region

string

resource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field

us-east-1

aws.account.id

string

resource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field

123456789012

aws.service

string

resource experimental
Display name: AWS service
The service that identifies the AWS product.

s3

aws.resource.type

string

resource experimental
Display name: AWS resource type
The name of a resource type in CloudFormation format.

AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function

aws.resource.id

string

resource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stable
Display name: AWS resource name
Name of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id).

my-ec2-instance

aws.arn

string

resource stable
Display name: AWS ARN
Amazon Resource Name (ARN).

arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend

cloud.provider

string

resource stable
Display name: Cloud provider
Name of the cloud provider.

alibaba_cloud

cloud.provider 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

alibaba_cloud

Alibaba Cloud

Alibaba Cloud

aws

Amazon Web Services

AWS

azure

Microsoft Azure

Azure

gcp

Google Cloud Platform

GCP

heroku

Heroku Platform as a Service

Heroku

ibm_cloud

IBM Cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Tencent Cloud

Amazon Relational Database Service option group fields

AttributeTypeDescriptionExamples

db.system

string

experimental
Display name: Database system
An 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