Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(lambda): support observability for ESM ( DDB, Kinesis, SQS) #32204

Merged
merged 9 commits into from
Nov 20, 2024

Conversation

roger-zhangg
Copy link
Member

Reason for this change

Lambda is introducing a new property in Event Sources named MetricsConfig to get enhanced metrics for user's event source that captures each stage of processing. Through this metrics customer can track flow of events through their EDA pipelines.

This feature is currently supported for DynamoDB, Kinesis and SQS event sources only.

Description of changes

This new property can be opted in by setting the MetricsConfig field while creating event sources. The example of opting for MetricsConfig for dynamoDB event is shown below:

fn.addEventSource(new eventsources.DynamoEventSource(table, {
  startingPosition: lambda.StartingPosition.LATEST,
  metricsConfig: {
    metrics: [MetricType.EVENT_COUNT],
  }
}))

Today there is only 1 metric type: EventCount. The metrics array can be either one element with EventCount or an empty array. More configuration support will be available in future

Description of how you validated changes

Have added unit test and integration test to validate the implementation

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added the p2 label Nov 20, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 20, 2024 00:40
@github-actions github-actions bot added the repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK label Nov 20, 2024
@xazhao
Copy link
Contributor

xazhao commented Nov 20, 2024

also the build failed with following error

aws-lambda-event-sources/lib/sqs.ts:78:28 - error JSII3001: Type "MetricsConfig" cannot be used as the property type because it is private or @internal

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.18%. Comparing base (baa8561) to head (a8e0e1d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32204   +/-   ##
=======================================
  Coverage   77.18%   77.18%           
=======================================
  Files         105      105           
  Lines        7161     7161           
  Branches     1312     1312           
=======================================
  Hits         5527     5527           
  Misses       1454     1454           
  Partials      180      180           
Flag Coverage Δ
suite.unit 77.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 77.18% <ø> (ø)
---- 🚨 Try these New Features:

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: a8e0e1d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Nov 20, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 6317a2a into aws:main Nov 20, 2024
18 checks passed
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants