AWS CDK Reference

Appearance

v2.273.0

InstrumentationVersion Class ​

Base class for instrumentation versions.

Provides functionality to generate image URIs for different instrumentation types.

Stability
Experimental
Source
lib/enablement/instrumentation-versions.ts

Example ​

ts
import { Construct } from 'constructs';
import * as appsignals from '@aws-cdk/aws-applicationsignals-alpha';
import * as cdk from 'aws-cdk-lib';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as ecs from 'aws-cdk-lib/aws-ecs';

class MyStack extends cdk.Stack {
  public constructor(scope?: Construct, id?: string, props: cdk.StackProps = {}) {
    super(scope, id, props);

    const vpc = new ec2.Vpc(this, 'TestVpc', {});
    const cluster = new ecs.Cluster(this, 'TestCluster', { vpc });

    // Define Task Definition for CloudWatch agent (Daemon)
    const cwAgentTaskDefinition = new ecs.Ec2TaskDefinition(this, 'CloudWatchAgentTaskDefinition', {
      networkMode: ecs.NetworkMode.HOST,
    });

    new appsignals.CloudWatchAgentIntegration(this, 'CloudWatchAgentIntegration', {
      taskDefinition: cwAgentTaskDefinition,
      containerName: 'ecs-cwagent',
      enableLogging: false,
      cpu: 128,
      memoryLimitMiB: 64,
      portMappings: [
        {
          containerPort: 4316,
          hostPort: 4316,
        },
        {
          containerPort: 2000,
          hostPort: 2000,
        },
      ],
    });

    // Create the CloudWatch Agent daemon service
    new ecs.Ec2Service(this, 'CloudWatchAgentDaemon', {
      cluster,
      taskDefinition: cwAgentTaskDefinition,
      daemon: true,  // Runs one container per EC2 instance
    });

    // Define Task Definition for user application
    const sampleAppTaskDefinition = new ecs.Ec2TaskDefinition(this, 'SampleAppTaskDefinition', {
      networkMode: ecs.NetworkMode.HOST,
    });

    sampleAppTaskDefinition.addContainer('app', {
      image: ecs.ContainerImage.fromRegistry('test/sample-app'),
      cpu: 0,
      memoryLimitMiB: 512,
    });

    // No CloudWatch Agent side car is needed as application container communicates to CloudWatch Agent daemon through host network
    new appsignals.ApplicationSignalsIntegration(this, 'ApplicationSignalsIntegration', {
      taskDefinition: sampleAppTaskDefinition,
      instrumentation: {
        sdkVersion: appsignals.PythonInstrumentationVersion.V0_8_0
      },
      serviceName: 'sample-app'
    });

    new ecs.Ec2Service(this, 'MySampleApp', {
      cluster,
      taskDefinition: sampleAppTaskDefinition,
      desiredCount: 1,
    });
  }
}

Initializer ​

ts
new InstrumentationVersion(imageRepo: string, version: string, memoryLimit: number)
python
InstrumentationVersion(image_repo: str, version: str, memory_limit: int | float)
java
new InstrumentationVersion(String imageRepo, String version, Number memoryLimit)
csharp
new InstrumentationVersion(string imageRepo, string version, double memoryLimit)
go
NewInstrumentationVersion(ImageRepo *string, Version *string, MemoryLimit *float64)

Methods ​

imageURI(): stringdef image_uri(self, ) -> strpublic String imageURI()public string ImageURI()func ImageURI() *string#
Get the image URI for the instrumentation version.
returns

Returns: The image URI.

memoryLimitMiB(): numberdef memory_limit_mi_b(self, ) -> int | floatpublic Number memoryLimitMiB()public double MemoryLimitMiB()func MemoryLimitMiB() *float64#
Get the memory limit in MiB for the instrumentation version.
returns

Returns: The memory limit