feat(logs): add support for fieldIndexPolicies in log group L2 Construct

[yashkh-amzn]

Issue # (if applicable)

#33366

Closes #33366

Reason for this change

Field Indexing for CloudWatch Logs (CWL) was launched in Nov 2024. A lot of CWL customers are asking for indexing support in L2 construct. This feature will enable that property under FieldIndexPolicies as a JSON object in the LogGroup construct.

Description of changes

The change here is just populating the fieldIndexPolicies property of the LogGroup CFN with the list of fields provided by the user. The format of this property will be like this:

const fieldIndexPolicy = new FieldIndexPolicy({
  fields: ['Operation', 'RequestId'],
});

new LogGroup(this, 'LogGroupLambda', {
  dataProtectionPolicy: dataProtectionPolicy,
  fieldIndexPolicies: [fieldIndexPolicy],
});

Describe any new or updated permissions being added

No new permissions have been added.

Description of how you validated changes

Added unit tests. Will add integ tests after getting a confirmation from the CDK team on the implementation.

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

[aws-cdk-automation]

(This review is outdated)

[yashkh-amzn]

Clarification Request

[aaythapa]

Clarification Request

Hi @yashkh-amzn thank you for contributing!

I see the PR is missing integ tests and read me changes. To learn more about our integ test process and how to make them you can refer to this doc.

As for README changes they will presumably go here.

Note that until the linter and build passes this PR won't show up on our radar to review. Let us know if there is anything else you need clarifying.

[yashkh-amzn]

Clarification Request

Hi @yashkh-amzn thank you for contributing!

I see the PR is missing integ tests and read me changes. To learn more about our integ test process and how to make them you can refer to this doc.

As for README changes they will presumably go here.

Note that until the linter and build passes this PR won't show up on our radar to review. Let us know if there is anything else you need clarifying.

Hey @aaythapa, I had a sync up with your team during the CDK office hours. I was told that the CDK team first wanted to align with the business logic and hence it was okay to submit a PR first for an initial review. Once there would be an alignment, I can update the integ tests and README.
cc: @kaizencc @shikha372 @gracelu0

[aaythapa]

Clarification Request

Hi @yashkh-amzn thank you for contributing!
I see the PR is missing integ tests and read me changes. To learn more about our integ test process and how to make them you can refer to this doc.
As for README changes they will presumably go here.
Note that until the linter and build passes this PR won't show up on our radar to review. Let us know if there is anything else you need clarifying.

Hey @aaythapa, I had a sync up with your team during the CDK office hours. I was told that the CDK team first wanted to align with the business logic and hence it was okay to submit a PR first for an initial review. Once there would be an alignment, I can update the integ tests and README. cc: @kaizencc @shikha372 @gracelu0

Ah ok, thanks for letting me know. I'll bring this up with the team and wait for a response

[shikha372]

what is the difference between this test and one above

[yashkh-amzn]

Good catch! This was a dedup. I'll remove this test case.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.21%. Comparing base (4bc151b) to head (11ffd90).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33416   +/-   ##
=======================================
  Coverage   82.21%   82.21%           
=======================================
  Files         119      119           
  Lines        6876     6876           
  Branches     1162     1162           
=======================================
  Hits         5653     5653           
  Misses       1120     1120           
  Partials      103      103           

Flag	Coverage Δ
suite.unit	82.21% <ø> (ø)

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

Components	Coverage Δ
packages/aws-cdk	∅ <ø> (∅)
packages/aws-cdk-lib/core	82.21% <ø> (ø)

[aws-cdk-automation]

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

[aws-cdk-automation]

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

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

[GavinZZ]

Removing the reviewer-clarification-requested label as it's been clarified that README and Integ test will be added once an initial review was done by the team and the contributor has added them now.

[shikha372]

for my understanding, could you please explain the purpose of defining log group destination and s3 destination in this code reference as i don't see it being used later while defining fieldIndexPolicy.

[yashkh-amzn]

This wasn't needed. Fixed it by removing all the unnecessary references.

[shikha372]

Thanks @yashkh-amzn, for field index policies you'll need to add the import in rosetta file,
https://github.com/yashkh-amzn/aws-cdk/blob/feature/loggroup-indexing/packages/aws-cdk-lib/rosetta/aws_logs/default.ts-fixture or modify it as logs.LogGroup

[yashkh-amzn]

Yes, I'm using logs.LogGroup. Take a look at the latest commit

[mergify]

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]

AWS CodeBuild CI Report

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

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

[mergify]

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

[github-actions]

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.