feat(apprunner): add ObservabilityConfiguration for AppRunner Service #30359

mazyu36 · 2024-05-28T10:09:28Z

Issue # (if applicable)

Closes #22985 .

Reason for this change

At the moment, L2 Construct does not support a tracing setting for the AppRunner Service.

Description of changes

Add ObservabilityConfiguration Class
Add observabilityConfiguration property to the Service Class

Description of how you validated changes

Add unit tests and integ tests.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

lpizzinidev

Thanks 👍
Left some comments for some minor adjustments and an open question on the vendor property.

lpizzinidev · 2024-06-01T15:12:20Z

packages/@aws-cdk/aws-apprunner-alpha/lib/index.ts

@@ -1,3 +1,4 @@
 // AWS::AppRunner CloudFormation Resources:
 export * from './service';
 export * from './vpc-connector';
+export * from './observability-configuration';


Can you please order this alphabetically?

Thanks. I fixed it.

packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts

packages/@aws-cdk/aws-apprunner-alpha/README.md

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

lpizzinidev · 2024-06-01T15:43:51Z

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

+ /**
+ * The implementation provider chosen for tracing App Runner services.
+ *
+ * @default Vendor.AWSXRAY


Suggested change

* @default Vendor.AWSXRAY

* @default - tracing is not enabled for the service

From the CloudFormation documentation, it seems we're allowed to omit this value.
Can you please verify if the construct deploys when that is the case?
Ie, changing the implementation to:

const resource = new CfnObservabilityConfiguration(this, 'Resource', { observabilityConfigurationName: props.observabilityConfigurationName, traceConfiguration: props.vendor ? { vendor: props.vendor, } : undefined, });

Thanks.
I fixed it, and I tried to deploy it.
An Observability Configuration without TraceConfiguration could be deployed.

% aws apprunner describe-observability-configuration --observability-configuration-arn arn:aws:apprunner:us-east-1: 01234567890:observabilityconfiguration/my-observability-no-vendor/1/2bc8fefaddcc4b878c0dfe2598412555 --region us-east-1 { "ObservabilityConfiguration": { "ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:01234567890:observabilityconfiguration/my-observability-no-vendor/1/2bc8fefaddcc4b878c0dfe2598412555", "ObservabilityConfigurationName": "my-observability-no-vendor", "ObservabilityConfigurationRevision": 1, "Latest": false, "Status": "ACTIVE", "CreatedAt": "2024-06-02T09:46:36.997000+09:00" } }

But the App Runner Service with it could not be deployed. It threw an error.

So, I added the above information to the documentation for the vendor property.

packages/@aws-cdk/aws-apprunner-alpha/test/service.test.ts

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

mazyu36 · 2024-06-02T02:32:06Z

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

@@ -143,15 +145,25 @@ export class ObservabilityConfiguration extends cdk.Resource implements IObserva
 physicalName: props.observabilityConfigurationName,
 });

+ if (props.observabilityConfigurationName !== undefined) {


Add a validation for observabilityConfigurationName and unit tests.

mazyu36 · 2024-06-02T03:01:54Z

@lpizzinidev
Thank you for the review!
I've addressed all your comments.

lpizzinidev

Thanks 👍 Left comments for some final adjustments

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

packages/@aws-cdk/aws-apprunner-alpha/test/service.test.ts

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

lpizzinidev

Thanks 👍

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

lpizzinidev

Thanks 👍

packages/@aws-cdk/aws-apprunner-alpha/test/obserbability-configuration.test.ts

GavinZZ

LGTM, thanks for contributing!

mergify · 2024-06-20T18:05:18Z

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).

GavinZZ · 2024-06-21T00:58:54Z

@mazyu36 Can you fix the failed unit test please when available?

Pull request has been modified.

mazyu36 · 2024-06-21T02:38:14Z

@GavinZZ
Thanks.
I've updated to resolve conflicts by #30358.

Could you please review and approve again?

mergify · 2024-06-24T17:18:58Z

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 · 2024-06-24T17:23:35Z

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).

aws-cdk-automation · 2024-06-24T18:49:32Z

AWS CodeBuild CI Report

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

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

mergify · 2024-06-24T18:49:51Z

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).

aws-cdk-automation · 2024-07-25T20:50:49Z

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 bot added admired-contributor [Pilot] contributed between 13-24 PRs to the CDK feature-request A feature should be added or improved. p2 labels May 28, 2024

aws-cdk-automation requested a review from a team May 28, 2024 10:09

add ObservabilityConfiguration for AppRunner Service

a4e11b4

mazyu36 force-pushed the apprunner-observability-22985 branch from 4dbae36 to a4e11b4 Compare May 28, 2024 10:40

feat: add fromArn method

e73b10d

mazyu36 force-pushed the apprunner-observability-22985 branch from c4002bf to e73b10d Compare May 28, 2024 23:53

Merge branch 'main' into apprunner-observability-22985

0027a86

mazyu36 marked this pull request as ready for review May 30, 2024 11:24

Merge branch 'main' into apprunner-observability-22985

78629f1

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 30, 2024

github-actions bot mentioned this pull request Jun 1, 2024

Monthly PR metrics report #30414

Closed

lpizzinidev suggested changes Jun 1, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 1, 2024

mazyu36 and others added 6 commits June 2, 2024 00:52

Update packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts

10277c4

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts

4af4868

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/README.md

c532781

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

8a7f2f7

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

b0cc774

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/test/service.test.ts

71da222

Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

mazyu36 force-pushed the apprunner-observability-22985 branch from 967bb81 to 8d7c747 Compare June 2, 2024 02:00

fix: incorporate review comments

b93cd9b

mazyu36 force-pushed the apprunner-observability-22985 branch from 8d7c747 to b93cd9b Compare June 2, 2024 02:28

mazyu36 commented Jun 2, 2024

View reviewed changes

lpizzinidev suggested changes Jun 2, 2024

View reviewed changes

mazyu36 and others added 3 commits June 3, 2024 00:04

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

d525912

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

4812423

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

d667bb4

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

lpizzinidev approved these changes Jun 3, 2024

View reviewed changes

packages/@aws-cdk/aws-apprunner-alpha/lib/observability-configuration.ts Outdated Show resolved Hide resolved

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 3, 2024

mazyu36 and others added 2 commits June 4, 2024 08:27

Update packages/@aws-cdk/aws-apprunner-alpha/lib/observability-config…

0594cd0

…uration.ts Co-authored-by: Luca Pizzini <lpizzini7@gmail.com>

Merge branch 'main' into apprunner-observability-22985

6d5a86c

lpizzinidev approved these changes Jun 11, 2024

View reviewed changes

mazyu36 added 2 commits June 19, 2024 11:03

fix: update from method

1e5f12e

add tag test

db48ffe

GavinZZ reviewed Jun 20, 2024

View reviewed changes

packages/@aws-cdk/aws-apprunner-alpha/test/obserbability-configuration.test.ts Show resolved Hide resolved

GavinZZ previously approved these changes Jun 20, 2024

View reviewed changes

Merge branch 'main' into apprunner-observability-22985

6eaaee0

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 20, 2024

resolve conflict

8459f87

Merge branch 'main' into apprunner-observability-22985

4718de2

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 21, 2024

mazyu36 requested a review from GavinZZ June 21, 2024 03:25

GavinZZ approved these changes Jun 24, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 24, 2024

Merge branch 'main' into apprunner-observability-22985

c850eb3

mergify bot merged commit 9e9cc27 into aws:main Jun 24, 2024
9 checks passed

mazyu36 deleted the apprunner-observability-22985 branch June 25, 2024 00:44

aws locked as resolved and limited conversation to collaborators Jul 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apprunner): add ObservabilityConfiguration for AppRunner Service #30359

feat(apprunner): add ObservabilityConfiguration for AppRunner Service #30359

mazyu36 commented May 28, 2024

lpizzinidev left a comment

lpizzinidev Jun 1, 2024

mazyu36 Jun 2, 2024

lpizzinidev Jun 1, 2024

mazyu36 Jun 2, 2024

mazyu36 Jun 2, 2024 •

edited

Loading

mazyu36 commented Jun 2, 2024

lpizzinidev left a comment

lpizzinidev left a comment

lpizzinidev left a comment

GavinZZ left a comment

mergify bot commented Jun 20, 2024

GavinZZ commented Jun 21, 2024

mazyu36 commented Jun 21, 2024

mergify bot commented Jun 24, 2024

mergify bot commented Jun 24, 2024

aws-cdk-automation commented Jun 24, 2024

mergify bot commented Jun 24, 2024

aws-cdk-automation commented Jul 25, 2024

	* @default Vendor.AWSXRAY
	* @default - tracing is not enabled for the service

feat(apprunner): add ObservabilityConfiguration for AppRunner Service #30359

feat(apprunner): add ObservabilityConfiguration for AppRunner Service #30359

Conversation

mazyu36 commented May 28, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev Jun 1, 2024

Choose a reason for hiding this comment

mazyu36 Jun 2, 2024

Choose a reason for hiding this comment

lpizzinidev Jun 1, 2024

Choose a reason for hiding this comment

mazyu36 Jun 2, 2024

Choose a reason for hiding this comment

mazyu36 Jun 2, 2024 • edited Loading

Choose a reason for hiding this comment

mazyu36 commented Jun 2, 2024

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev left a comment

Choose a reason for hiding this comment

GavinZZ left a comment

Choose a reason for hiding this comment

mergify bot commented Jun 20, 2024

GavinZZ commented Jun 21, 2024

mazyu36 commented Jun 21, 2024

mergify bot commented Jun 24, 2024

mergify bot commented Jun 24, 2024

aws-cdk-automation commented Jun 24, 2024

AWS CodeBuild CI Report

mergify bot commented Jun 24, 2024

aws-cdk-automation commented Jul 25, 2024

mazyu36 Jun 2, 2024 •

edited

Loading