Experimental
@aws-cdk/aws-applicationsignals-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ApplicationSignalsIntegrationProps Struct
Interface for Application Signals properties.
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,
});
}
}
Properties
cloudWatchAgentSidecarCloudWatchAgentOptionscloud_watch_agent_sidecarCloudWatchAgentOptionscloudWatchAgentSidecarCloudWatchAgentOptionsCloudWatchAgentSidecarCloudWatchAgentOptionsCloudWatchAgentSidecarCloudWatchAgentOptions= a basic agent sidecar container …#The CloudWatch Agent properties.
default
Default: a basic agent sidecar container with latest public image
instrumentationInstrumentationPropsinstrumentationInstrumentationPropsinstrumentationInstrumentationPropsInstrumentationInstrumentationPropsInstrumentationInstrumentationPropsrequired#The instrumentation properties.
overrideEnvironmentsEnvironmentExtension[]override_environmentstyping.List[EnvironmentExtension]overrideEnvironmentsList<EnvironmentExtension>OverrideEnvironmentsEnvironmentExtension[]OverrideEnvironments*[]EnvironmentExtension= no environment variables to over…#The environment variables to override.
default
Default: no environment variables to override.
serviceNamestringservice_namestrserviceNameStringServiceNamestringServiceName*string= task definition family name#The name of the service.
taskDefinitionTaskDefinitiontask_definitionTaskDefinitiontaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionrequired#The task definition to integrate Application Signals into.
[disable-awslint:ref-via-interface]