Skip to content

/AWS1/CL_CWSSERVICE

This structure contains information about one of your services that was discovered by Application Signals.

CONSTRUCTOR

IMPORTING

Required arguments:

it_keyattributes TYPE /AWS1/CL_CWSATTRIBUTES_W=>TT_ATTRIBUTES TT_ATTRIBUTES

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

it_metricreferences TYPE /AWS1/CL_CWSMETRICREFERENCE=>TT_METRICREFERENCES TT_METRICREFERENCES

An array of structures that each contain information about one metric associated with this service.

Optional arguments:

it_attributemaps TYPE /AWS1/CL_CWSATTRIBUTEMAP_W=>TT_ATTRIBUTEMAPS TT_ATTRIBUTEMAPS

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

Platform attributes contain information the service's platform.

  • PlatformType defines the hosted-in platform.

  • EKS.Cluster is the name of the Amazon EKS cluster.

  • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

  • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

  • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

  • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

  • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

  • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

  • EC2.InstanceId is the ID of the Amazon EC2 instance.

  • Host is the name of the host, for all platform types.

Application attributes contain information about the application.

  • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

  • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

Telemetry attributes contain telemetry information.

  • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

  • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

  • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

it_servicegroups TYPE /AWS1/CL_CWSSERVICEGROUP=>TT_SERVICEGROUPS TT_SERVICEGROUPS

An array of service groups that this service belongs to, based on the configured grouping attributes.

it_loggroupreferences TYPE /AWS1/CL_CWSATTRIBUTES_W=>TT_LOGGROUPREFERENCES TT_LOGGROUPREFERENCES

An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

  • "Type": "AWS::Resource"

  • "ResourceType": "AWS::Logs::LogGroup"

  • "Identifier": "name-of-log-group"

Queryable Attributes

KeyAttributes

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

Accessible with the following methods

Method Description
GET_KEYATTRIBUTES() Getter for KEYATTRIBUTES, with configurable default
ASK_KEYATTRIBUTES() Getter for KEYATTRIBUTES w/ exceptions if field has no value
HAS_KEYATTRIBUTES() Determine if KEYATTRIBUTES has a value

AttributeMaps

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

Platform attributes contain information the service's platform.

  • PlatformType defines the hosted-in platform.

  • EKS.Cluster is the name of the Amazon EKS cluster.

  • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

  • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

  • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

  • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

  • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

  • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

  • EC2.InstanceId is the ID of the Amazon EC2 instance.

  • Host is the name of the host, for all platform types.

Application attributes contain information about the application.

  • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

  • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

Telemetry attributes contain telemetry information.

  • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

  • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

  • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

Accessible with the following methods

Method Description
GET_ATTRIBUTEMAPS() Getter for ATTRIBUTEMAPS, with configurable default
ASK_ATTRIBUTEMAPS() Getter for ATTRIBUTEMAPS w/ exceptions if field has no value
HAS_ATTRIBUTEMAPS() Determine if ATTRIBUTEMAPS has a value

ServiceGroups

An array of service groups that this service belongs to, based on the configured grouping attributes.

Accessible with the following methods

Method Description
GET_SERVICEGROUPS() Getter for SERVICEGROUPS, with configurable default
ASK_SERVICEGROUPS() Getter for SERVICEGROUPS w/ exceptions if field has no value
HAS_SERVICEGROUPS() Determine if SERVICEGROUPS has a value

MetricReferences

An array of structures that each contain information about one metric associated with this service.

Accessible with the following methods

Method Description
GET_METRICREFERENCES() Getter for METRICREFERENCES, with configurable default
ASK_METRICREFERENCES() Getter for METRICREFERENCES w/ exceptions if field has no va
HAS_METRICREFERENCES() Determine if METRICREFERENCES has a value

LogGroupReferences

An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

  • "Type": "AWS::Resource"

  • "ResourceType": "AWS::Logs::LogGroup"

  • "Identifier": "name-of-log-group"

Accessible with the following methods

Method Description
GET_LOGGROUPREFERENCES() Getter for LOGGROUPREFERENCES, with configurable default
ASK_LOGGROUPREFERENCES() Getter for LOGGROUPREFERENCES w/ exceptions if field has no
HAS_LOGGROUPREFERENCES() Determine if LOGGROUPREFERENCES has a value