Skip to content

chore(kinesisfirehose-destinations): refactor logging to combine logGroup and logging properties into loggingConfig#31488

Merged
mergify[bot] merged 8 commits intoaws:mainfrom
paulhcsun:destinations-logging-refactor
Sep 25, 2024
Merged

chore(kinesisfirehose-destinations): refactor logging to combine logGroup and logging properties into loggingConfig#31488
mergify[bot] merged 8 commits intoaws:mainfrom
paulhcsun:destinations-logging-refactor

Conversation

@paulhcsun
Copy link
Copy Markdown
Contributor

@paulhcsun paulhcsun commented Sep 19, 2024

Reason for this change

The logging and logGroup properties contain a restriction where a logGroup cannot be provided if logging is set to false. This was previously handled by error handling but we want to change this to make it impossible for a user to run into that scenario in the first place.

Description of changes

BREAKING CHANGE: the logging and logGroup properties in DestinationLoggingProps have been removed and replaced with a single optional property loggingConfig which accepts a class of type LoggingConfig.

Details

Combine the logging and logGroup properties into a single new optional property called loggingConfig which accepts a class of type LoggingConfig.

LoggingConfig is an abstract class which can be instantiated through either an instance of EnableLogging or DisableLogging which can be used in the following 3 ways:

import * as logs from 'aws-cdk-lib/aws-logs';

const logGroup = new logs.LogGroup(this, 'Log Group');
declare const bucket: s3.Bucket;

// 1. Enable logging with no parameters - a log group will be created for you
const destinationWithLogging = new destinations.S3Bucket(bucket, {
  loggingConfig: new destinations.EnableLogging(),
});

// 2. Enable a logging and pass in a logGroup to be used
const destinationWithLoggingAndMyLogGroup = new destinations.S3Bucket(bucket, {
  loggingConfig: new destinations.EnableLogging(logGroup),
});

// 3. Disable logging (does not accept any parameters so it is now impossible to provide a logGroup in this case)
const destinationWithoutLogging = new destinations.S3Bucket(bucket, {
  loggingConfig: new destinations.DisableLogging(),
});

Description of how you validated changes

unit + integ test

Checklist


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

…roup and logging properties into loggingConfig
@aws-cdk-automation aws-cdk-automation requested a review from a team September 19, 2024 00:52
@github-actions github-actions bot added the p2 label Sep 19, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 19, 2024
Copy link
Copy Markdown
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation dismissed their stale review September 19, 2024 00:56

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@paulhcsun paulhcsun marked this pull request as ready for review September 19, 2024 00:56
@shikha372 shikha372 self-assigned this Sep 20, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 23, 2024
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 25, 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 c4bda64 into aws:main Sep 25, 2024
@github-actions
Copy link
Copy Markdown
Contributor

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 Sep 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

contribution/core This is a PR that came from AWS. p2 pr/needs-maintainer-review This PR needs a review from a Core Team Member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants