interface Monitoring

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.Monitoring
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#Monitoring
Java	software.amazon.awscdk.services.stepfunctions.tasks.Monitoring
Python	aws_cdk.aws_stepfunctions_tasks.Monitoring
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » Monitoring

Configuration setting for monitoring.

Example

new tasks.EmrContainersStartJobRun(this, 'EMR Containers Start Job Run', {
  virtualCluster: tasks.VirtualClusterInput.fromVirtualClusterId('de92jdei2910fwedz'),
  releaseLabel: tasks.ReleaseLabel.EMR_6_2_0,
  jobDriver: {
    sparkSubmitJobDriver: {
      entryPoint: sfn.TaskInput.fromText('local:///usr/lib/spark/examples/src/main/python/pi.py'),
      sparkSubmitParameters: '--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1',
    },
  },
  monitoring: {
    logging: true,
  },
});

Properties

Name	Type	Description
logBucket?	IBucket	Amazon S3 Bucket for monitoring log publishing.
logGroup?	ILogGroup	A log group for CloudWatch monitoring.
logStreamNamePrefix?	string	A log stream name prefix for Cloudwatch monitoring.
logging?	boolean	Enable logging for this job.
persistentAppUI?	boolean	Monitoring configurations for the persistent application UI.

---

logBucket?

Type: IBucket (optional, default: if logging is manually set to true and a logBucket is not provided, a logBucket will be automatically generated`.)

Amazon S3 Bucket for monitoring log publishing.

You can configure your jobs to send log information to Amazon S3.

---

logGroup?

Type: ILogGroup (optional, default: if logging is manually set to true and a logGroup is not provided, a logGroup will be automatically generated`.)

A log group for CloudWatch monitoring.

You can configure your jobs to send log information to CloudWatch Logs.

---

logStreamNamePrefix?

Type: string (optional, default: Log streams created in this log group have no default prefix)

A log stream name prefix for Cloudwatch monitoring.

---

logging?

Type: boolean (optional, default: true - true if values are provided for logGroup or logBucket, false otherwise)

Enable logging for this job.

If set to true, will automatically create a Cloudwatch Log Group and S3 bucket. This will be set to true implicitly if values are provided for logGroup or logBucket.

---

persistentAppUI?

Type: boolean (optional, default: true)

Monitoring configurations for the persistent application UI.