Try it free

Smartscape - AWS

  • Reference
  • Published May 07, 2026

This section documents a set of preconfigured entities that are created for AWS based on AWS resources. All entity types are prefixed with AWS_*. You can get an overview of all AWS entities with the following DQL query:

smartscapeNodes "AWS_*"
| summarize by:type, count()

All AWS entities have at least the following fields:

AWS resource fields

AttributeTypeDescriptionExamples

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.arn

string

resource stableAmazon Resource Name (ARN).

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

aws.object

string

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

ID giving fields

The Smartscape ID for a given entity is calculated based on the ARN of the AWS resource.

AWS object

The aws.object field contains the configuration of the resource as JSON string.

AWS tags

All AWS tags of an entity are captured automatically and available via the tags:aws and additionally via the tags field. E.g. to access the CREATED_BY tag you can use tags[CREATED_BY].

Permission fields

All AWS entities support the following fields to set up permissions:

  • aws.account.id
  • dt.security_context

AWS Account

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ACCOUNT

This entity represents an AWS Account.

Query

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

smartscapeNodes "AWS_ACCOUNT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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 Account fields

AttributeTypeDescriptionExamples

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

AWS Account relationship fields

AWS App Runner VPC connector

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPRUNNER_VPCCONNECTOR

This entity represents an AWS App Runner VPC connector.

Query

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

smartscapeNodes "AWS_APPRUNNER_VPCCONNECTOR"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS App Runner VPC connector relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS App Runner VPC ingress connection

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPRUNNER_VPCINGRESSCONNECTION

This entity represents an AWS App Runner VPC ingress connection.

Query

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

smartscapeNodes "AWS_APPRUNNER_VPCINGRESSCONNECTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS App Runner VPC ingress connection relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_apprunner_service``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_ec2_vpcendpoint

AWS App Runner auto scaling configuration

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPRUNNER_AUTOSCALINGCONFIGURATION

This entity represents an AWS App Runner auto scaling configuration.

Query

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

smartscapeNodes "AWS_APPRUNNER_AUTOSCALINGCONFIGURATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS App Runner auto scaling configuration relationship fields

AWS App Runner service

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPRUNNER_SERVICE

This entity represents an AWS App Runner service.

Query

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

smartscapeNodes "AWS_APPRUNNER_SERVICE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS App Runner service relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_apprunner_vpcconnector

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_apprunner_autoscalingconfiguration``smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

AWS AppSync GraphQL API

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPSYNC_GRAPHQLAPI

This entity represents an AWS AppSync GraphQL API.

Query

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

smartscapeNodes "AWS_APPSYNC_GRAPHQLAPI"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS AppSync GraphQL API relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_cognito_userpool``smartscapeId dt.smartscape.aws_lambda_function``smartscapeId dt.smartscape.aws_wafv2_webacl

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS Auto Scaling auto scaling group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_AUTOSCALING_AUTOSCALINGGROUP

This entity represents an AWS Auto Scaling auto scaling group.

Query

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

smartscapeNodes "AWS_AUTOSCALING_AUTOSCALINGGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

AWS Auto Scaling auto scaling group relationship fields

AttributeTypeDescriptionExamples

contains

record

stableRelationship field that contains all contains-relationships as nested fields.Opposite direction: belongs_toRelationships:smartscapeId dt.smartscape.aws_ec2_instance

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_elasticloadbalancing_loadbalancer``smartscapeId dt.smartscape.aws_elasticloadbalancingv2_targetgroup

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_launchtemplate

K8S_POD uses K8S_CONFIGMAP

AWS Availability Zone

Smartscape node name: aws.resource.name

Smartscape node type: AWS_AVAILABILITY_ZONE

This entity represents a physical AWS Availability Zone (e.g. use1-az1).

Query

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

smartscapeNodes "AWS_AVAILABILITY_ZONE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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 Availability Zone fields

AttributeTypeDescriptionExamples

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

AWS Availability Zone relationship fields

AttributeTypeDescriptionExamples

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_region

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

AWS Backup backup plan

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BACKUP_BACKUPPLAN

This entity represents an AWS Backup backup plan.

Query

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

smartscapeNodes "AWS_BACKUP_BACKUPPLAN"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Backup backup plan relationship fields

AWS Backup backup vault

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BACKUP_BACKUPVAULT

This entity represents an AWS Backup backup vault.

Query

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

smartscapeNodes "AWS_BACKUP_BACKUPVAULT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Backup backup vault relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias``smartscapeId dt.smartscape.aws_sns_topic

K8S_POD uses K8S_CONFIGMAP

AWS Certificate Manager certificate

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CERTIFICATEMANAGER_CERTIFICATE

This entity represents an AWS Certificate Manager certificate.

Query

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

smartscapeNodes "AWS_CERTIFICATEMANAGER_CERTIFICATE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Certificate Manager certificate relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_acmpca_certificateauthority

K8S_POD uses K8S_CONFIGMAP

AWS Client VPN endpoint

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_CLIENTVPNENDPOINT

This entity represents an AWS Client VPN endpoint.

Query

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

smartscapeNodes "AWS_EC2_CLIENTVPNENDPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Client VPN endpoint relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS CloudHSM cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CLOUDHSM_CLUSTER

This entity represents an AWS CloudHSM cluster.

Query

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

smartscapeNodes "AWS_CLOUDHSM_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

AWS CloudHSM cluster relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS CloudTrail trail

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CLOUDTRAIL_TRAIL

This entity represents an AWS CloudTrail trail.

Query

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

smartscapeNodes "AWS_CLOUDTRAIL_TRAIL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS CloudTrail trail relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_logs_loggroup``smartscapeId dt.smartscape.aws_sns_topic``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

AWS CodeBuild project

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CODEBUILD_PROJECT

This entity represents an AWS CodeBuild project.

Query

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

smartscapeNodes "AWS_CODEBUILD_PROJECT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS CodeBuild project relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS DataSync task

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DATASYNC_TASK

This entity represents an AWS DataSync task.

Query

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

smartscapeNodes "AWS_DATASYNC_TASK"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS DataSync task relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_logs_loggroup

K8S_POD uses K8S_CONFIGMAP

AWS Database Migration Service (DMS) replication instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DMS_REPLICATIONINSTANCE

This entity represents an AWS Database Migration Service (DMS) replication instance.

Query

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

smartscapeNodes "AWS_DMS_REPLICATIONINSTANCE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

AWS Database Migration Service (DMS) replication instance relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS Direct Connect connection

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DIRECTCONNECT_DXCON

This entity represents an AWS Direct Connect connection.

Query

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

smartscapeNodes "AWS_DIRECTCONNECT_DXCON"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Direct Connect connection relationship fields

AWS Direct Connect virtual interface

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DIRECTCONNECT_DXVIF

This entity represents an AWS Direct Connect virtual interface.

Query

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

smartscapeNodes "AWS_DIRECTCONNECT_DXVIF"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Direct Connect virtual interface relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_directconnect_dxcon

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_ec2_vpngateway

AWS EC2 Identity and Access Management (IAM) instance profile association

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_IAMINSTANCEPROFILEASSOCIATION

This entity represents an Amazon EC2 Identity and Access Management (IAM) instance profile association.

Query

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

smartscapeNodes "AWS_EC2_IAMINSTANCEPROFILEASSOCIATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS EC2 Identity and Access Management (IAM) instance profile association relationship fields

AWS Elastic Beanstalk application

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICBEANSTALK_APPLICATION

This entity represents an AWS Elastic Beanstalk application.

Query

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

smartscapeNodes "AWS_ELASTICBEANSTALK_APPLICATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Elastic Beanstalk application relationship fields

AWS Elastic Beanstalk environment

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICBEANSTALK_ENVIRONMENT

This entity represents an AWS Elastic Beanstalk environment.

Query

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

smartscapeNodes "AWS_ELASTICBEANSTALK_ENVIRONMENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Elastic Beanstalk environment relationship fields

AttributeTypeDescriptionExamples

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_elasticbeanstalk_application

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_launchtemplate``smartscapeId dt.smartscape.aws_sqs_queue

K8S_POD uses K8S_CONFIGMAP

AWS Elastic Load Balancing classic load balancer

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICLOADBALANCING_LOADBALANCER

This entity represents an AWS Elastic Load Balancing classic load balancer.

Query

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

smartscapeNodes "AWS_ELASTICLOADBALANCING_LOADBALANCER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

AWS Elastic Load Balancing classic load balancer relationship fields

AttributeTypeDescriptionExamples

balances

record

stableRelationship field that contains all balances-relationships as nested fields.Opposite direction: balanced_byRelationships:smartscapeId dt.smartscape.aws_ec2_instance

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_iam_servercertificate``smartscapeId dt.smartscape.aws_certificatemanager_certificate

K8S_POD uses K8S_CONFIGMAP

AWS Elastic Load Balancing v2 listener

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICLOADBALANCINGV2_LISTENER

This entity represents an AWS Elastic Load Balancing v2 listener.

Query

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

smartscapeNodes "AWS_ELASTICLOADBALANCINGV2_LISTENER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Elastic Load Balancing v2 listener relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_elasticloadbalancingv2_loadbalancer``smartscapeId dt.smartscape.aws_elasticloadbalancingv2_targetgroup

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_servercertificate``smartscapeId dt.smartscape.aws_certificatemanager_certificate

K8S_POD uses K8S_CONFIGMAP

AWS Elastic Load Balancing v2 load balancer (application, network, gateway)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICLOADBALANCINGV2_LOADBALANCER

This entity represents an AWS Elastic Load Balancing v2 load balancer (application, network, gateway).

Query

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

smartscapeNodes "AWS_ELASTICLOADBALANCINGV2_LOADBALANCER"

Fetch all Smartcape nodes from the smartscape-nodes table and filter for the entity type "AWS_ELASTICLOADBALANCINGV2_LOADBALANCER" nodes that are internet-facing, then traverse their relationships to list their associated Target Groups and target EC2 Instances.

smartscapeNodes "AWS_ELASTICLOADBALANCINGV2_LOADBALANCER"
| parse aws.object, "JSON:aws.object"
| fieldsAdd dnsName = aws.object[configuration][dnsName], loadBalancerName = aws.object[configuration][loadBalancerName], scheme = aws.object[configuration][scheme]
| filter scheme == "internet-facing"
| traverse "balanced_by", "AWS_ELASTICLOADBALANCINGV2_TARGETGROUP", direction:"backward", fieldsKeep:{dnsName, loadBalancerName, id}
| fieldsAdd targetGroupName = "aws.resource.name"
| traverse "balances", "AWS_EC2_INSTANCE", fieldsKeep: {targetGroupName,id}
| fieldsAdd loadBalancerName = dt.traverse.history[-2][loadBalancerName],
            loadBalancerDnsName = dt.traverse.history[-2][dnsName],
            loadBalancerId = dt.traverse.history[-2][id],
            targetGroupName = dt.traverse.history[-1][targetGroupName],
            targetGroupId = dt.traverse.history[-1][id]

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

AWS Elastic Load Balancing v2 load balancer (application, network, gateway) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS Elastic Load Balancing v2 target group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICLOADBALANCINGV2_TARGETGROUP

This entity represents an AWS Elastic Load Balancing v2 target group.

Query

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

smartscapeNodes "AWS_ELASTICLOADBALANCINGV2_TARGETGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Elastic Load Balancing v2 target group relationship fields

AttributeTypeDescriptionExamples

balanced_by

record

stableRelationship field that contains all balanced_by-relationships as nested fields.Opposite direction: balancesRelationships:smartscapeId dt.smartscape.aws_elasticloadbalancingv2_loadbalancer

balances

record

stableRelationship field that contains all balances-relationships as nested fields.Opposite direction: balanced_byRelationships:smartscapeId dt.smartscape.aws_ec2_instance``smartscapeId dt.smartscape.aws_lambda_function

AWS Global Accelerator accelerator

Smartscape node name: aws.resource.name

Smartscape node type: AWS_GLOBALACCELERATOR_ACCELERATOR

This entity represents an AWS Global Accelerator accelerator.

Query

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

smartscapeNodes "AWS_GLOBALACCELERATOR_ACCELERATOR"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Global Accelerator relationship fields

AWS Glue job

Smartscape node name: aws.resource.name

Smartscape node type: AWS_GLUE_JOB

This entity represents an AWS Glue job.

Query

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

smartscapeNodes "AWS_GLUE_JOB"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Glue job relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

AWS Identity and Access Management (IAM) group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_GROUP

This entity represents an AWS Identity and Access Management (IAM) group.

Query

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

smartscapeNodes "AWS_IAM_GROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) group relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_managedpolicy

K8S_POD uses K8S_CONFIGMAP

AWS Identity and Access Management (IAM) instance profile

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_INSTANCEPROFILE

This entity represents an AWS Identity and Access Management (IAM) instance profile.

Query

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

smartscapeNodes "AWS_IAM_INSTANCEPROFILE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) instance profile relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_iam_role

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS Identity and Access Management (IAM) managed policy

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_MANAGEDPOLICY

This entity represents an AWS Identity and Access Management (IAM) managed policy.

Query

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

smartscapeNodes "AWS_IAM_MANAGEDPOLICY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) managed policy relationship fields

AWS Identity and Access Management (IAM) role

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_ROLE

This entity represents an AWS Identity and Access Management (IAM) role.

Query

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

smartscapeNodes "AWS_IAM_ROLE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) role relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_managedpolicy

K8S_POD uses K8S_CONFIGMAP

AWS Identity and Access Management (IAM) server certificate

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_SERVERCERTIFICATE

This entity represents an AWS Identity and Access Management (IAM) server certificate.

Query

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

smartscapeNodes "AWS_IAM_SERVERCERTIFICATE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) server certificate relationship fields

AWS Identity and Access Management (IAM) user

Smartscape node name: aws.resource.name

Smartscape node type: AWS_IAM_USER

This entity represents an AWS Identity and Access Management (IAM) user.

Query

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

smartscapeNodes "AWS_IAM_USER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Identity and Access Management (IAM) user relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_iam_group

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_managedpolicy

K8S_POD uses K8S_CONFIGMAP

AWS Key Management Service (KMS) alias

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KMS_ALIAS

This entity represents an AWS Key Management Service (KMS) alias.

Query

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

smartscapeNodes "AWS_KMS_ALIAS"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Key Management Service (KMS) alias relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

AWS Key Management Service (KMS) key

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KMS_KEY

This entity represents an AWS Key Management Service (KMS) key.

Query

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

smartscapeNodes "AWS_KMS_KEY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Key Management Service (KMS) key relationship fields

AWS Lambda alias

Smartscape node name: aws.resource.name

Smartscape node type: AWS_LAMBDA_ALIAS

This entity represents an AWS Lambda alias.

Query

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

smartscapeNodes "AWS_LAMBDA_ALIAS"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Lambda alias relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_lambda_function

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS Lambda event source mapping

Smartscape node name: aws.resource.name

Smartscape node type: AWS_LAMBDA_EVENTSOURCEMAPPING

This entity represents an AWS Lambda event source mapping.

Query

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

smartscapeNodes "AWS_LAMBDA_EVENTSOURCEMAPPING"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Lambda event source mapping relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_lambda_function

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_sqs_queue``smartscapeId dt.smartscape.aws_dynamodb_table

K8S_POD uses K8S_CONFIGMAP

AWS Lambda function

Smartscape node name: aws.resource.name

Smartscape node type: AWS_LAMBDA_FUNCTION

This entity represents an AWS Lambda function.

Query

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

smartscapeNodes "AWS_LAMBDA_FUNCTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Lambda function relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

AWS Network Firewall firewall

Smartscape node name: aws.resource.name

Smartscape node type: AWS_NETWORKFIREWALL_FIREWALL

This entity represents an AWS Network Firewall firewall.

Query

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

smartscapeNodes "AWS_NETWORKFIREWALL_FIREWALL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Network Firewall relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_networkfirewall_firewallpolicy

K8S_POD uses K8S_CONFIGMAP

AWS Network Firewall firewall policy

Smartscape node name: aws.resource.name

Smartscape node type: AWS_NETWORKFIREWALL_FIREWALLPOLICY

This entity represents an AWS Network Firewall firewall policy.

Query

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

smartscapeNodes "AWS_NETWORKFIREWALL_FIREWALLPOLICY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Network Firewall policy relationship fields

AWS Private Certificate Authority private CA

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ACMPCA_CERTIFICATEAUTHORITY

This entity represents an AWS Private Certificate Authority private CA.

Query

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

smartscapeNodes "AWS_ACMPCA_CERTIFICATEAUTHORITY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Private Certificate Authority private CA relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_s3_bucket

K8S_POD uses K8S_CONFIGMAP

AWS Region

Smartscape node name: aws.resource.name

Smartscape node type: AWS_REGION

This entity represents an AWS Region.

Query

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

smartscapeNodes "AWS_REGION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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 Region fields

AttributeTypeDescriptionExamples

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

AWS Region relationship fields

AWS Site-to-Site VPN Customer Gateway

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_CUSTOMERGATEWAY

This entity represents an AWS Site-to-Site VPN Customer Gateway.

Query

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

smartscapeNodes "AWS_EC2_CUSTOMERGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Site-to-Site VPN Customer Gateway relationship fields

AWS Site-to-Site VPN vpn connection

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPNCONNECTION

This entity represents an AWS Site-to-Site VPN vpn connection.

Query

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

smartscapeNodes "AWS_EC2_VPNCONNECTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Site-to-Site VPN relationship fields

AttributeTypeDescriptionExamples

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_ec2_vpngateway``smartscapeId dt.smartscape.aws_ec2_customergateway``smartscapeId dt.smartscape.aws_ec2_transitgateway

AWS Site-to-Site VPN vpn gateway

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPNGATEWAY

This entity represents an AWS Site-to-Site VPN vpn gateway.

Query

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

smartscapeNodes "AWS_EC2_VPNGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Site-to-Site VPN vpn gateway relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS Step Functions state machine

Smartscape node name: aws.resource.name

Smartscape node type: AWS_STEPFUNCTIONS_STATEMACHINE

This entity represents an AWS Step Functions state machine.

Query

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

smartscapeNodes "AWS_STEPFUNCTIONS_STATEMACHINE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Step Functions state machine relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_logs_loggroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

AWS Storage Gateway gateway

Smartscape node name: aws.resource.name

Smartscape node type: AWS_STORAGEGATEWAY_GATEWAY

This entity represents an AWS Storage Gateway gateway.

Query

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

smartscapeNodes "AWS_STORAGEGATEWAY_GATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Storage Gateway gateway relationship fields

AttributeTypeDescriptionExamples

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_ec2_instance

AWS Transit Gateway transit gateway

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_TRANSITGATEWAY

This entity represents an AWS Transit Gateway.

Query

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

smartscapeNodes "AWS_EC2_TRANSITGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS Transit Gateway transit gateway relationship fields

AWS Transit Gateway transit gateway attachment

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_TRANSITGATEWAYATTACHMENT

This entity represents an AWS Transit Gateway transit gateway attachment.

Query

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

smartscapeNodes "AWS_EC2_TRANSITGATEWAYATTACHMENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

AWS Transit Gateway attachment relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_transitgateway``smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_vpnconnection``smartscapeId dt.smartscape.aws_ec2_transitgateway

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

AWS WAFv2 webACL

Smartscape node name: aws.resource.name

Smartscape node type: AWS_WAFV2_WEBACL

This entity represents an AWS WAFv2 web ACL.

Query

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

smartscapeNodes "AWS_WAFV2_WEBACL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

AWS WAFv2 webACL relationship fields

Amazon API Gateway (REST) stage

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_STAGE

This entity represents an Amazon API Gateway (REST) stage, which is a named reference to a deployment of the API.

Query

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

smartscapeNodes "AWS_APIGATEWAY_STAGE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon API Gateway (REST) stage relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_apigateway_restapi

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon API Gateway REST API

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_RESTAPI

This entity represents an Amazon API Gateway REST API.

Query

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

smartscapeNodes "AWS_APIGATEWAY_RESTAPI"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon API Gateway REST API relationship fields

Amazon API Gateway v2 API (HTTP or WebSocket)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_API

This entity represents an Amazon API Gateway v2 API (HTTP or WebSocket).

Query

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

smartscapeNodes "AWS_APIGATEWAYV2_API"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon API Gateway v2 API (HTTP or WebSocket) relationship fields

Amazon API Gateway v2 stage (HTTP or WebSocket)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_STAGE

This entity represents an Amazon API Gateway v2 stage (HTTP or WebSocket), which is a named reference to a deployment of the API.

Query

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

smartscapeNodes "AWS_APIGATEWAYV2_STAGE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon API Gateway v2 stage (HTTP or WebSocket) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_apigatewayv2_api

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon AppStream fleet

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APPSTREAM_FLEET

This entity represents an Amazon AppStream fleet.

Query

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

smartscapeNodes "AWS_APPSTREAM_FLEET"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon AppStream fleet relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon Athena workgroup

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ATHENA_WORKGROUP

This entity represents an AWS Athena workgroup.

Query

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

smartscapeNodes "AWS_ATHENA_WORKGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Athena workgroup relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Bedrock agent

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BEDROCK_AGENT

This entity represents an Amazon Bedrock agent.

Query

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

smartscapeNodes "AWS_BEDROCK_AGENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Bedrock agent relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_bedrock_guardrail

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Bedrock agent alias

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BEDROCK_AGENTALIAS

This entity represents an Amazon Bedrock agent alias.

Query

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

smartscapeNodes "AWS_BEDROCK_AGENTALIAS"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Bedrock agent alias relationship fields

Amazon Bedrock guardrail

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BEDROCK_GUARDRAIL

This entity represents an Amazon Bedrock guardrail.

Query

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

smartscapeNodes "AWS_BEDROCK_GUARDRAIL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Bedrock guardrail relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Bedrock knowledgebase

Smartscape node name: aws.resource.name

Smartscape node type: AWS_BEDROCK_KNOWLEDGEBASE

This entity represents an Amazon Bedrock knowledgebase.

Query

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

smartscapeNodes "AWS_BEDROCK_KNOWLEDGEBASE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Bedrock knowledgebase relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_redshift_cluster``smartscapeId dt.smartscape.aws_redshiftserverless_workgroup``smartscapeId dt.smartscape.aws_opensearch_domain``smartscapeId dt.smartscape.aws_opensearchserverless_collection``smartscapeId dt.smartscape.aws_rds_dbcluster

K8S_POD uses K8S_CONFIGMAP

Amazon CloudFront distribution

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CLOUDFRONT_DISTRIBUTION

This entity represents an Amazon CloudFront distribution.

Query

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

smartscapeNodes "AWS_CLOUDFRONT_DISTRIBUTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon CloudFront distribution relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_wafv2_webacl

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_s3_bucket

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_servercertificate

K8S_POD uses K8S_CONFIGMAP

Amazon CloudWatch Logs delivery destination

Smartscape node name: aws.resource.name

Smartscape node type: AWS_LOGS_DELIVERYDESTINATION

This entity represents an Amazon CloudWatch Logs delivery destination.

Query

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

smartscapeNodes "AWS_LOGS_DELIVERYDESTINATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon CloudWatch Logs delivery destination relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_logs_loggroup``smartscapeId dt.smartscape.aws_kinesisfirehose_deliverystream

K8S_POD uses K8S_CONFIGMAP

Amazon CloudWatch Logs log group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_LOGS_LOGGROUP

This entity represents an Amazon CloudWatch Logs log group.

Query

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

smartscapeNodes "AWS_LOGS_LOGGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon CloudWatch Logs log group relationship fields

AttributeTypeDescriptionExamples

calls

record

stableDefines a "horizontal" relationship between two entities that "call" each other. The "calls" relation does not imply a parent/child or other strong structural relation but rather a dynamic communication association. Examples: Typical examples include services calling other services, but also services calling databases, queue brokers, or other infrastructure entities.Relationships:smartscapeId dt.smartscape.aws_lambda_function``smartscapeId dt.smartscape.aws_kinesisfirehose_deliverystream``smartscapeId dt.smartscape.aws_opensearch_domain

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias``smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon Cognito user pool

Smartscape node name: aws.resource.name

Smartscape node type: AWS_COGNITO_USERPOOL

This entity represents an Amazon Cognito user pool.

Query

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

smartscapeNodes "AWS_COGNITO_USERPOOL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Cognito user pool relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_lambda_function``smartscapeId dt.smartscape.aws_sns_topic

K8S_POD uses K8S_CONFIGMAP

Amazon Connect instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CONNECT_INSTANCE

This entity represents an Amazon Connect instance.

Query

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

smartscapeNodes "AWS_CONNECT_INSTANCE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Connect instance relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon DynamoDB Accelerator (DAX) cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DAX_CLUSTER

This entity represents an Amazon DynamoDB Accelerator (DAX) cluster.

Query

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

smartscapeNodes "AWS_DAX_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon DynamoDB Accelerator (DAX) cluster fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon DynamoDB Accelerator (DAX) cluster relationship fields

AttributeTypeDescriptionExamples

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_dax_subnetgroup``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon DynamoDB Accelerator (DAX) subnet group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DAX_SUBNETGROUP

This entity represents an Amazon DynamoDB Accelerator (DAX) subnet group.

Query

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

smartscapeNodes "AWS_DAX_SUBNETGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon DynamoDB Accelerator (DAX) subnet group relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_subnet

K8S_POD uses K8S_CONFIGMAP

Amazon DynamoDB table

Smartscape node name: aws.resource.name

Smartscape node type: AWS_DYNAMODB_TABLE

This entity represents an Amazon DynamoDB table.

Query

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

smartscapeNodes "AWS_DYNAMODB_TABLE"

Fetch all AWS_DYNAMODB_TABLE nodes from the smartscape.nodes table and filter those with continuous backup disabled.

smartscapeNodes "AWS_DYNAMODB_TABLE"
| parse aws.object, "JSON:aws.object"
| fieldsAdd continuousBackupStatus = aws.object[supplementary_configuration][continuousBackupsDescription][continuousBackupsStatus]
| filter continuousBackupStatus!="ENABLED"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon DynamoDB table fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon DynamoDB table relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon EBS snapshot

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_SNAPSHOT

This entity represents an Amazon EBS snapshot.

Query

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

smartscapeNodes "AWS_EC2_SNAPSHOT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EBS snapshot relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon EBS volume

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VOLUME

This entity represents an Amazon EBS volume.

Query

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

smartscapeNodes "AWS_EC2_VOLUME"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon EBS volume relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_instance

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon EC2 elastic IP address

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_EIP

This entity represents an Amazon EC2 elastic IP address.

Query

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

smartscapeNodes "AWS_EC2_EIP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EC2 elastic IP address relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_networkinterface``smartscapeId dt.smartscape.aws_ec2_instance

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon EC2 elastic IP association

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_EIPASSOCIATION

This entity represents an Amazon EC2 elastic IP association.

Query

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

smartscapeNodes "AWS_EC2_EIPASSOCIATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EC2 elastic IP association relationship fields

Amazon EC2 elastic network interface

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_NETWORKINTERFACE

This entity represents an Amazon EC2 elastic network interface.

Query

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

smartscapeNodes "AWS_EC2_NETWORKINTERFACE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon EC2 elastic network interface relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_instance``smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon EC2 elastic network interface attachment

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_NETWORKINTERFACEATTACHMENT

This entity represents an Amazon EC2 elastic network interface attachment.

Query

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

smartscapeNodes "AWS_EC2_NETWORKINTERFACEATTACHMENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon EC2 elastic network interface attachment relationship fields

AttributeTypeDescriptionExamples

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

Amazon EC2 instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_INSTANCE

This entity represents an Amazon EC2 instance.

Query

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

smartscapeNodes "AWS_EC2_INSTANCE"

Fetch all "AWS_EC2_INSTANCE" nodes from the smartscape.nodes table and show the instance type, number of cores, number of threads per core, image id, public IP address and private IP address.

smartscapeNodes "AWS_EC2_INSTANCE"
| parse aws.object, "JSON:awsjson"
| fieldsAdd instanceType=awsjson[configuration][instanceType],
            cpuOptions.coreCount=awsjson[configuration][cpuOptions][coreCount],
            cpuOptions.threadsPerCore=awsjson[configuration][cpuOptions][threadsPerCore],
            imageId=awsjson[configuration][imageId],
            publicIp=awsjson[configuration][networkInterfaces][0][association][publicIp],
            privateIp=awsjson[configuration][privateIpAddress]
| fieldsRemove  aws.object, awsjson

Fetch all "AWS_EC2_INSTANCE" nodes from the smartscape.nodes table tagged with owner_team=team-acme and running in VPC vpc-abcde12345.

smartscapeNodes "AWS_EC2_INSTANCE"
| filter tags[owner_team]=="team-acme" and aws.vpc.id =="vpc-abcde12345"

Fetch an "AWS_EC2_INSTANCE" node from the smartscape.nodes table with id i-abcde12345 and traverse its relationships to "AWS_EC2_VOLUME" nodes that have an edge of type is_attached_to towards the fetched AWS_EC2_INSTANCE.

smartscapeNodes "AWS_EC2_INSTANCE"
| filter aws.resource.id=="i-abcde12345"
| traverse "is_attached_to","AWS_EC2_VOLUME", direction:backward

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon EC2 instance relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_iam_instanceprofile

K8S_POD uses K8S_CONFIGMAP

Amazon EC2 launch template

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_LAUNCHTEMPLATE

This entity represents an Amazon EC2 launch template.

Query

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

smartscapeNodes "AWS_EC2_LAUNCHTEMPLATE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EC2 launch template relationship fields

Amazon EC2 security group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_SECURITYGROUP

This entity represents an Amazon EC2 security group.

Query

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

smartscapeNodes "AWS_EC2_SECURITYGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon EC2 security group relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon ECR public repository

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECR_PUBLICREPOSITORY

This entity represents an Amazon ECR public repository.

Query

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

smartscapeNodes "AWS_ECR_PUBLICREPOSITORY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECR public repository relationship fields

Amazon ECR repository

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECR_REPOSITORY

This entity represents an Amazon ECR repository.

Query

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

smartscapeNodes "AWS_ECR_REPOSITORY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECR repository relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon ECS capacity provider

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_CAPACITYPROVIDER

This entity represents an Amazon ECS capacity provider.

Query

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

smartscapeNodes "AWS_ECS_CAPACITYPROVIDER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECS capacity provider relationship fields

Amazon ECS cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_CLUSTER

This entity represents an Amazon ECS cluster.

Query

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

smartscapeNodes "AWS_ECS_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECS cluster relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ecs_capacityprovider

K8S_POD uses K8S_CONFIGMAP

Amazon ECS container instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_CONTAINERINSTANCE

This entity represents an Amazon ECS container instance.

Query

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

smartscapeNodes "AWS_ECS_CONTAINERINSTANCE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECS container instance relationship fields

AttributeTypeDescriptionExamples

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_ec2_instance``smartscapeId dt.smartscape.aws_ecs_capacityprovider

Amazon ECS service

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_SERVICE

This entity represents an Amazon ECS service.

Query

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

smartscapeNodes "AWS_ECS_SERVICE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECS service relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_ecs_cluster

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ecs_taskdefinition``smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon ECS task

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_TASK

This entity represents an Amazon ECS task.

Query

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

smartscapeNodes "AWS_ECS_TASK"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon ECS task relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_ecs_cluster

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_ecs_service

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_ecs_containerinstance``smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ecs_taskdefinition``smartscapeId dt.smartscape.aws_ec2_networkinterface

K8S_POD uses K8S_CONFIGMAP

Amazon ECS task definition

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ECS_TASKDEFINITION

This entity represents an Amazon ECS task definition.

Query

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

smartscapeNodes "AWS_ECS_TASKDEFINITION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ECS task definition relationship fields

Amazon EKS cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EKS_CLUSTER

This entity represents an Amazon EKS cluster.

Query

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

smartscapeNodes "AWS_EKS_CLUSTER"

Fetch all AWS_EKS_CLUSTER nodes from the smartscape.nodes table and show a subset of configuration attributes.

smartscapeNodes "AWS_EKS_CLUSTER"
| parse aws.object, "JSON:aws.object"
| fieldsAdd clusterName = aws.object[configuration][name],
            clusterEndpoint = aws.object[configuration][endpoint],
            endpointPublicAccess = aws.object[configuration][resourcesVpcConfig][endpointPublicAccess],
            endpointPrivateAccess = aws.object[configuration][resourcesVpcConfig][endpointPrivateAccess],
            platformVersion = aws.object[configuration][platformVersion]
| fieldsRemove aws.object

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon EKS cluster relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon EKS nodegroup

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EKS_NODEGROUP

This entity represents an Amazon EKS nodegroup.

Query

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

smartscapeNodes "AWS_EKS_NODEGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EKS nodegroup relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_eks_cluster

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_ec2_launchtemplate``smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon ElastiCache Serverless Cache

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICACHE_SERVERLESSCACHE

This entity represents an Amazon ElastiCache serverless cache.

Query

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

smartscapeNodes "AWS_ELASTICACHE_SERVERLESSCACHE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ElastiCache Serverless Cache fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon ElastiCache Serverless Cache relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon ElastiCache cache cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICACHE_CACHECLUSTER

This entity represents an Amazon ElastiCache cache cluster.

Query

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

smartscapeNodes "AWS_ELASTICACHE_CACHECLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ElastiCache cache cluster fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon ElastiCache cache cluster relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_elasticache_parametergroup``smartscapeId dt.smartscape.aws_elasticache_subnetgroup``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon ElastiCache parameter group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICACHE_PARAMETERGROUP

This entity represents an Amazon ElastiCache parameter group.

Query

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

smartscapeNodes "AWS_ELASTICACHE_PARAMETERGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon ElastiCache parameter group fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon ElastiCache parameter group relationship fields

Amazon ElastiCache subnet group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ELASTICACHE_SUBNETGROUP

This entity represents an Amazon ElastiCache subnet group.

Query

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

smartscapeNodes "AWS_ELASTICACHE_SUBNETGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon ElastiCache subnet group relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon Elastic File System access point

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EFS_ACCESSPOINT

This entity represents an Amazon Elastic File System access point.

Query

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

smartscapeNodes "AWS_EFS_ACCESSPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic File System access point relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_efs_filesystem

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon Elastic File System file system

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EFS_FILESYSTEM

This entity represents an Amazon Elastic File System file system.

Query

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

smartscapeNodes "AWS_EFS_FILESYSTEM"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic File System file system relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon Elastic File System mount target

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EFS_MOUNTTARGET

This entity represents an Amazon Elastic File System mount target.

Query

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

smartscapeNodes "AWS_EFS_MOUNTTARGET"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon Elastic File System mount target relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_efs_filesystem

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_networkinterface

K8S_POD uses K8S_CONFIGMAP

Amazon Elastic MapReduce Serverless application

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EMRSERVERLESS_APPLICATION

This entity represents an Amazon Elastic MapReduce Serverless application.

Query

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

smartscapeNodes "AWS_EMRSERVERLESS_APPLICATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic MapReduce Serverless application relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon Elastic MapReduce cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EMR_CLUSTER

This entity represents an Amazon Elastic MapReduce cluster.

Query

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

smartscapeNodes "AWS_EMR_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic MapReduce cluster relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon Elastic MapReduce on EKS Managed endpoint

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EMRCONTAINERS_MANAGEDENDPOINT

This entity represents an Amazon Elastic MapReduce on EKS Managed endpoint.

Query

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

smartscapeNodes "AWS_EMRCONTAINERS_MANAGEDENDPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic MapReduce on EKS Managed endpoint relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_emrcontainers_virtualcluster

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_ec2_subnet

K8S_POD uses K8S_CONFIGMAP

Amazon Elastic MapReduce on EKS virtual cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EMRCONTAINERS_VIRTUALCLUSTER

This entity represents an Amazon Elastic MapReduce on EKS virtual cluster.

Query

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

smartscapeNodes "AWS_EMRCONTAINERS_VIRTUALCLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Elastic MapReduce on EKS virtual cluster relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_eks_cluster

K8S_POD uses K8S_CONFIGMAP

Amazon EventBridge event bus

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EVENTS_EVENTBUS

This entity represents an Amazon EventBridge event bus.

Query

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

smartscapeNodes "AWS_EVENTS_EVENTBUS"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EventBridge event bus relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_sqs_queue``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon EventBridge rule

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EVENTS_RULE

This entity represents an Amazon EventBridge rule.

Query

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

smartscapeNodes "AWS_EVENTS_RULE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon EventBridge rule relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_events_eventbus

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon FSx file system (Lustre, Windows, OpenZFS, NetApp ONTAP)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_FSX_FILESYSTEM

This entity represents an Amazon FSx file system - Managed file storage service (Lustre, Windows, OpenZFS, NetApp ONTAP).

Query

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

smartscapeNodes "AWS_FSX_FILESYSTEM"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon FSx file system (Lustre, Windows, OpenZFS, NetApp ONTAP) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon FSx storage virtual machine (FSx ONTAP)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_FSX_STORAGEVIRTUALMACHINE

This entity represents an Amazon FSx storage virtual machine for FSx ONTAP file systems.

Query

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

smartscapeNodes "AWS_FSX_STORAGEVIRTUALMACHINE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon FSx storage virtual machine (FSx ONTAP) relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_fsx_filesystem

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

Amazon FSx volume (FSx ONTAP, FSx OpenZFS)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_FSX_VOLUME

This entity represents an Amazon FSx volume - Storage volume for FSx ONTAP or FSx OpenZFS file systems.

Query

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

smartscapeNodes "AWS_FSX_VOLUME"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon FSx volume (FSx ONTAP, FSx OpenZFS) relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_fsx_filesystem

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

Amazon Keyspaces (for Apache Cassandra) table

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CASSANDRA_TABLE

This entity represents an Amazon Keyspaces (for Apache Cassandra) table. A table is where data is organized and stored in Amazon Keyspaces.

Query

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

smartscapeNodes "AWS_CASSANDRA_TABLE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Keyspaces (for Apache Cassandra) table fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Keyspaces (for Apache Cassandra) table relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_cassandra_keyspace

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Keyspaces(for Apache Cassandra) keyspace

Smartscape node name: aws.resource.name

Smartscape node type: AWS_CASSANDRA_KEYSPACE

This entity represents an Amazon Keyspaces(for Apache Cassandra) keyspace. A keyspace groups related tables that are relevant for one or more applications.

Query

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

smartscapeNodes "AWS_CASSANDRA_KEYSPACE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Keyspaces (for Apache Cassandra) keyspace fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Keyspaces (for Apache Cassandra) keyspace relationship fields

Amazon Kinesis Data Firehose delivery stream

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KINESISFIREHOSE_DELIVERYSTREAM

This entity represents an Amazon Kinesis Data Firehose delivery stream.

Query

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

smartscapeNodes "AWS_KINESISFIREHOSE_DELIVERYSTREAM"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Kinesis Data Firehose delivery stream relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_opensearch_domain``smartscapeId dt.smartscape.aws_opensearchserverless_collection``smartscapeId dt.smartscape.aws_redshift_cluster

K8S_POD uses K8S_CONFIGMAP

Amazon Kinesis data stream

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KINESIS_STREAM

This entity represents an Amazon Kinesis data stream.

Query

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

smartscapeNodes "AWS_KINESIS_STREAM"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Kinesis data stream relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon MQ broker

Smartscape node name: aws.resource.name

Smartscape node type: AWS_AMAZONMQ_BROKER

This entity represents an Amazon MQ broker.

Query

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

smartscapeNodes "AWS_AMAZONMQ_BROKER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon MQ broker relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_amazonmq_configuration``smartscapeId dt.smartscape.aws_logs_loggroup

K8S_POD uses K8S_CONFIGMAP

Amazon MQ configuration

Smartscape node name: aws.resource.name

Smartscape node type: AWS_AMAZONMQ_CONFIGURATION

This entity represents an Amazon MQ configuration containing the settings used by brokers.

Query

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

smartscapeNodes "AWS_AMAZONMQ_CONFIGURATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon MQ configuration relationship fields

Amazon Managed Service for Apache Flink application

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KINESISANALYTICSV2_APPLICATION

This entity represents an Amazon Managed Service for Apache Flink application.

Query

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

smartscapeNodes "AWS_KINESISANALYTICSV2_APPLICATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Managed Service for Apache Flink application relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon Managed Streaming for Apache Kafka (MSK) Connect connector

Smartscape node name: aws.resource.name

Smartscape node type: AWS_KAFKACONNECT_CONNECTOR

This entity represents an Amazon Managed Streaming for Apache Kafka (MSK) Connect connector.

Query

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

smartscapeNodes "AWS_KAFKACONNECT_CONNECTOR"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Managed Streaming for Apache Kafka (MSK) Connect connector relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon Managed Streaming for Apache Kafka (MSK) cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_MSK_CLUSTER

This entity represents an Amazon Managed Streaming for Apache Kafka (MSK) cluster.

Query

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

smartscapeNodes "AWS_MSK_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Managed Streaming for Apache Kafka (MSK) cluster relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon Managed Workflows for Apache Airflow (MWAA) environment

Smartscape node name: aws.resource.name

Smartscape node type: AWS_MWAA_ENVIRONMENT

This entity represents an Amazon Managed Apache Airflow (MWAA) environment

Query

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

smartscapeNodes "AWS_MWAA_ENVIRONMENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Managed Workflows for Apache Airflow (MWAA) environment relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon OpenSearch Serverless collection

Smartscape node name: aws.resource.name

Smartscape node type: AWS_OPENSEARCHSERVERLESS_COLLECTION

This entity represents an Amazon OpenSearch Serverless collection.

Query

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

smartscapeNodes "AWS_OPENSEARCHSERVERLESS_COLLECTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon OpenSearch Serverless collection fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon OpenSearch Serverless collection relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon OpenSearch Service domain

Smartscape node name: aws.resource.name

Smartscape node type: AWS_OPENSEARCH_DOMAIN

This entity represents an Amazon OpenSearch Service domain.

Query

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

smartscapeNodes "AWS_OPENSEARCH_DOMAIN"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon OpenSearch Service domain fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon OpenSearch Service domain relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Redshift Serverless namespace

Smartscape node name: aws.resource.name

Smartscape node type: AWS_REDSHIFTSERVERLESS_NAMESPACE

This entity represents an Amazon Redshift Serverless namespace.

Query

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

smartscapeNodes "AWS_REDSHIFTSERVERLESS_NAMESPACE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Redshift Serverless namespace fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Redshift Serverless namespace relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon Redshift Serverless workgroup

Smartscape node name: aws.resource.name

Smartscape node type: AWS_REDSHIFTSERVERLESS_WORKGROUP

This entity represents an Amazon Redshift Serverless workgroup.

Query

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

smartscapeNodes "AWS_REDSHIFTSERVERLESS_WORKGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Redshift Serverless workgroup fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Redshift Serverless workgroup relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon Redshift cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_REDSHIFT_CLUSTER

This entity represents an Amazon Redshift cluster.

Query

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

smartscapeNodes "AWS_REDSHIFT_CLUSTER"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Redshift cluster fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Redshift cluster relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_redshift_subnetgroup``smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_kms_key

K8S_POD uses K8S_CONFIGMAP

Amazon Redshift subnet group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_REDSHIFT_SUBNETGROUP

This entity represents an Amazon Redshift subnet group.

Query

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

smartscapeNodes "AWS_REDSHIFT_SUBNETGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Redshift subnet group relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon Relational Database Service (RDS) DB cluster

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBCLUSTER

This entity represents an Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon Relational Database Service (RDS) DB cluster fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Relational Database Service (RDS) DB cluster relationship fields

AttributeTypeDescriptionExamples

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_rds_dbsubnetgroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Relational Database Service (RDS) DB cluster snapshot

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBCLUSTERSNAPSHOT

This entity represents an Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Relational Database Service (RDS) DB cluster snapshot fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Relational Database Service (RDS) DB cluster snapshot relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_rds_dbcluster

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Relational Database Service (RDS) DB instance

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBINSTANCE

This entity represents an Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon Relational Database Service (RDS) DB instance fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Relational Database Service (RDS) DB instance relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_rds_dbcluster

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_securitygroup``smartscapeId dt.smartscape.aws_rds_dbsubnetgroup``smartscapeId dt.smartscape.aws_rds_optiongroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Relational Database Service (RDS) DB snapshot

Smartscape node name: aws.resource.name

Smartscape node type: AWS_RDS_DBSNAPSHOT

This entity represents an Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon Relational Database Service (RDS) DB snapshot fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Relational Database Service (RDS) DB snapshot relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

is_part_of

record

stableDefines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent).Relationships:smartscapeId dt.smartscape.aws_rds_dbinstance

AWS_EC2_INSTANCE is_part_of AWS_AUTOSCALING_GROUP; K8S_POD is_part_of K8S_DEPLOYMENT

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_rds_optiongroup``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Relational Database Service (RDS) DB subnet group relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon Relational Database Service (RDS) 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"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Relational Database Service (RDS) option group fields

AttributeTypeDescriptionExamples

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.

ValueDescription

adabas

Adabas (Adaptable Database System)

amazon-documentdb

Amazon DocumentDB

aurora-mysql

Amazon Aurora MySQL

aurora-postgresql

Amazon Aurora PostgreSQL

cache

InterSystems Caché

cassandra

Apache Cassandra

clickhouse

ClickHouse

cloudscape

Cloudscape

cockroachdb

CockroachDB

coldfusion

ColdFusion IMQ

cosmosdb

Microsoft Azure Cosmos DB

couchbase

Couchbase

couchdb

CouchDB

db2

IBM Db2

derby

Apache Derby

dl/i

IBM DL/I

dynamodb

Amazon DynamoDB

edb

EnterpriseDB

elasticsearch

Elasticsearch

filemaker

FileMaker

firebird

Firebird

firstsql

FirstSQL

geode

Apache Geode

h2

H2

hanadb

SAP HANA

hbase

Apache HBase

hive

Apache Hive

hsqldb

HyperSQL DataBase

informix

Informix

ingres

Ingres

instantdb

InstantDB

interbase

InterBase

keyspaces-cassandra

Amazon Keyspaces for Apache Cassandra

mariadb

MariaDB

maxdb

SAP MaxDB

memcached

Memcached

mongodb

MongoDB

mssql

Microsoft SQL Server

mssqlcompact

Microsoft SQL Server Compact

mysql

MySQL

neo4j

Neo4j

neptune

Amazon Neptune

netezza

Netezza

opensearch

OpenSearch

oracle

Oracle Database

other_sql

Some other SQL database. Fallback only. See notes.

pervasive

Pervasive PSQL

pointbase

PointBase

postgresql

PostgreSQL

progress

Progress Database

redis

Redis

redshift

Amazon Redshift

spanner

Cloud Spanner

sqlite

SQLite

sybase

Sybase

teradata

Teradata

valkey

Valkey

vertica

Vertica

Amazon Relational Database Service (RDS) option group relationship fields

Amazon Route 53 Resolver resolver endpoint

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ROUTE53RESOLVER_RESOLVERENDPOINT

This entity represents an Amazon Route 53 Resolver resolver endpoint.

Query

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

smartscapeNodes "AWS_ROUTE53RESOLVER_RESOLVERENDPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Route 53 Resolver endpoint relationship fields

Amazon Route 53 health check

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ROUTE53_HEALTHCHECK

This entity represents an Amazon Route 53 health check.

Query

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

smartscapeNodes "AWS_ROUTE53_HEALTHCHECK"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Route 53 health check relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_route53_healthcheck

K8S_POD uses K8S_CONFIGMAP

Amazon Route 53 hosted zone

Smartscape node name: aws.resource.name

Smartscape node type: AWS_ROUTE53_HOSTEDZONE

This entity represents an Amazon Route 53 hosted zone.

Query

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

smartscapeNodes "AWS_ROUTE53_HOSTEDZONE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon Route 53 hosted zone relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon S3 bucket

Smartscape node name: aws.resource.name

Smartscape node type: AWS_S3_BUCKET

This entity represents an Amazon S3 bucket.

Query

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

smartscapeNodes "AWS_S3_BUCKET"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon S3 bucket relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon SageMaker endpoint

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SAGEMAKER_ENDPOINT

This entity represents an Amazon SageMaker endpoint.

Query

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

smartscapeNodes "AWS_SAGEMAKER_ENDPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon SageMaker endpoint relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon SageMaker feature group

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SAGEMAKER_FEATUREGROUP

This entity represents an Amazon SageMaker feature group.

Query

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

smartscapeNodes "AWS_SAGEMAKER_FEATUREGROUP"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon SageMaker feature group relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon SageMaker inference component

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SAGEMAKER_INFERENCECOMPONENT

This entity represents an Amazon SageMaker inference component.

Query

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

smartscapeNodes "AWS_SAGEMAKER_INFERENCECOMPONENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon SageMaker inference component relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_sagemaker_endpoint

K8S_POD uses K8S_CONFIGMAP

Amazon SageMaker labeling job

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SAGEMAKER_LABELINGJOB

This entity represents an Amazon SageMaker labeling job.

Query

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

smartscapeNodes "AWS_SAGEMAKER_LABELINGJOB"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon SageMaker labeling job relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon SageMaker pipeline

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SAGEMAKER_PIPELINE

This entity represents an Amazon SageMaker pipeline.

Query

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

smartscapeNodes "AWS_SAGEMAKER_PIPELINE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon SageMaker pipeline relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role

K8S_POD uses K8S_CONFIGMAP

Amazon Simple Notification Service (SNS) topic

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SNS_TOPIC

This entity represents an Amazon Simple Notification Service (SNS) topic.

Query

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

smartscapeNodes "AWS_SNS_TOPIC"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Simple Notification Service (SNS) topic relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon Simple Queue Service (SQS) queue

Smartscape node name: aws.resource.name

Smartscape node type: AWS_SQS_QUEUE

This entity represents an Amazon Simple Queue Service (SQS) queue.

Query

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

smartscapeNodes "AWS_SQS_QUEUE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon Simple Queue Service (SQS) queue relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_kms_key``smartscapeId dt.smartscape.aws_kms_alias

K8S_POD uses K8S_CONFIGMAP

Amazon VPC DHCP options set

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_DHCPOPTIONS

This entity represents an Amazon VPC DHCP options set.

Query

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

smartscapeNodes "AWS_EC2_DHCPOPTIONS"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC DHCP options set relationship fields

Amazon VPC IP address manager

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_IPAM

This entity represents an Amazon VPC IP address manager for planning and tracking IP address usage.

Query

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

smartscapeNodes "AWS_EC2_IPAM"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC IP address manager relationship fields

Amazon VPC IP address manager pool

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_IPAMPOOL

This entity represents an Amazon VPC IP address manager pool.

Query

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

smartscapeNodes "AWS_EC2_IPAMPOOL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC IP address manager pool relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_ec2_ipamscope

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

Amazon VPC IP address manager scope

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_IPAMSCOPE

This entity represents an Amazon VPC IP address manager scope.

Query

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

smartscapeNodes "AWS_EC2_IPAMSCOPE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC IP address manager scope relationship fields

AttributeTypeDescriptionExamples

belongs_to

record

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).Relationships:smartscapeId dt.smartscape.aws_ec2_ipam

SERVICE belongs_to K8S_CLUSTER; K8S_POD belongs_to K8S_NAMESPACE

Amazon VPC NAT gateway

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_NATGATEWAY

This entity represents an Amazon VPC NAT gateway.

Query

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

smartscapeNodes "AWS_EC2_NATGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC NAT gateway relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon VPC egress-only internet gateway (IPv6)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_EGRESSONLYINTERNETGATEWAY

This entity represents an Amazon VPC egress-only internet gateway (IPv6).

Query

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

smartscapeNodes "AWS_EC2_EGRESSONLYINTERNETGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC egress-only internet gateway (IPv6) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon VPC endpoint (PrivateLink)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPCENDPOINT

This entity represents an Amazon VPC endpoint (PrivateLink).

Query

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

smartscapeNodes "AWS_EC2_VPCENDPOINT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC endpoint (PrivateLink) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_networkinterface``smartscapeId dt.smartscape.aws_ec2_securitygroup

K8S_POD uses K8S_CONFIGMAP

Amazon VPC endpoint service (PrivateLink)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPCENDPOINTSERVICE

This entity represents an Amazon VPC endpoint service (PrivateLink).

Query

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

smartscapeNodes "AWS_EC2_VPCENDPOINTSERVICE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon VPC endpoint service (PrivateLink) relationship fields

AttributeTypeDescriptionExamples

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_elasticloadbalancingv2_loadbalancer``smartscapeId dt.smartscape.aws_elasticloadbalancingv2_loadbalancer

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

Amazon VPC flow log

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_FLOWLOG

This entity represents an Amazon VPC flow log.

Query

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

smartscapeNodes "AWS_EC2_FLOWLOG"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC flow log relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_networkinterface

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_iam_role``smartscapeId dt.smartscape.aws_s3_bucket``smartscapeId dt.smartscape.aws_logs_loggroup``smartscapeId dt.smartscape.aws_kinesisfirehose_deliverystream

K8S_POD uses K8S_CONFIGMAP

Amazon VPC internet gateway (IPv4)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_INTERNETGATEWAY

This entity represents an Amazon VPC internet gateway (IPv4).

Query

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

smartscapeNodes "AWS_EC2_INTERNETGATEWAY"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC internet gateway (IPv4) relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon VPC network ACL

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_NETWORKACL

This entity represents an Amazon VPC network ACL.

Query

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

smartscapeNodes "AWS_EC2_NETWORKACL"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC network ACL relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_subnet``smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

Amazon VPC route table

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_ROUTETABLE

This entity represents an Amazon VPC route table.

Query

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

smartscapeNodes "AWS_EC2_ROUTETABLE"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned Security Group or array of Groups

sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec

Amazon VPC route table relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc``smartscapeId dt.smartscape.aws_ec2_subnet

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_ec2_instance``smartscapeId dt.smartscape.aws_ec2_networkinterface``smartscapeId dt.smartscape.aws_ec2_vpngateway``smartscapeId dt.smartscape.aws_ec2_internetgateway``smartscapeId dt.smartscape.aws_ec2_egressonlyinternetgateway``smartscapeId dt.smartscape.aws_ec2_vpcendpoint``smartscapeId dt.smartscape.aws_ec2_natgateway``smartscapeId dt.smartscape.aws_ec2_transitgateway``smartscapeId dt.smartscape.aws_ec2_vpcpeeringconnection

Amazon VPC subnet

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_SUBNET

This entity represents an Amazon VPC subnet.

Query

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

smartscapeNodes "AWS_EC2_SUBNET"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM 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

experimentalAssigned VPC (Virtual Private Cloud)

vpc-0be61db7c5d2d1bd1

aws.subnet.id

string

experimentalAssigned Subnet or array of Subnets

subnet-03759a11ef3811b94; subnet-011dad1de2a016171

aws.security_group.id

string

experimentalAssigned 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 stableA specific availability zone or array of zones in given AWS region.

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

Amazon VPC subnet relationship fields

AttributeTypeDescriptionExamples

is_attached_to

record

stableIs (typically) exclusively attached to the instance (1-many)Relationships:smartscapeId dt.smartscape.aws_ec2_vpc

AWS_EBS_VOLUME is_attached_to AWS_EC2_INSTANCE; AZURE_NETWORK_INTERFACE is_attached_to AZURE_VIRTUAL_SUBNETWORK

runs_on

record

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.Relationships:smartscapeId dt.smartscape.aws_availability_zone

Amazon VPC subnet network ACL attachment

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_SUBNETNETWORKACLATTACHMENT

This entity represents an Amazon VPC subnet network ACL attachment.

Query

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

smartscapeNodes "AWS_EC2_SUBNETNETWORKACLATTACHMENT"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC subnet network ACL attachment relationship fields

Amazon VPC subnet route table association

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_SUBNETROUTETABLEASSOCIATION

This entity represents an Amazon VPC subnet route table association.

Query

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

smartscapeNodes "AWS_EC2_SUBNETROUTETABLEASSOCIATION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC subnet route table association relationship fields

Amazon VPC virtual private cloud

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPC

This entity represents an Amazon VPC virtual private cloud.

Query

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

smartscapeNodes "AWS_EC2_VPC"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC virtual private cloud relationship fields

AttributeTypeDescriptionExamples

uses

record

stableSimilar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch TemplateRelationships:smartscapeId dt.smartscape.aws_ec2_dhcpoptions

K8S_POD uses K8S_CONFIGMAP

Amazon VPC vpc peering connection

Smartscape node name: aws.resource.name

Smartscape node type: AWS_EC2_VPCPEERINGCONNECTION

This entity represents an Amazon VPC vpc peering connection.

Query

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

smartscapeNodes "AWS_EC2_VPCPEERINGCONNECTION"

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

[]

Cloud entity fields

Fields that are provided by all Cloud workloads.

AttributeTypeDescriptionExamples

cloud.acquisition.status

string

experimentalThe 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

stableThe full JSON content of any aws object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}

aws.properties.version

string

experimentalThe aws.object json content version

1.0

aws.region

string

resource stableA specific geographical AWS Cloud location.Tags: primary-field

us-east-1

aws.account.id

string

resource stableThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account.Tags: permission primary-field

123456789012

aws.service

string

resource experimentalThe service that identifies the AWS product.

s3

aws.resource.type

string

resource experimentalThe name of a resource type in CloudFormation format.

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

aws.resource.id

string

resource stableUnique, immutable identifier assigned to the AWS cloud resource.

i-0922cda4579db3a45

aws.resource.name

string

resource stableName 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 stableAmazon Resource Name (ARN).

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

cloud.provider

string

resource stableName 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.

ValueDescription

alibaba_cloud

Alibaba Cloud

aws

Amazon Web Services

azure

Microsoft Azure

gcp

Google Cloud Platform

heroku

Heroku Platform as a Service

ibm_cloud

IBM Cloud

tencent_cloud

Tencent Cloud

Amazon VPC vpc peering connection relationship fields

AttributeTypeDescriptionExamples

routes_to

record

stableDefine network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPCRelationships:smartscapeId dt.smartscape.aws_ec2_vpc