Log Aggregation fix on Checkout failure (group by reason, not Quote ID) #37871

lbajsarowicz · 2023-08-10T09:24:05Z

Description (*)

More and more projects use log aggregation tools - either self-hosted like Kibana, or SaaS like NewRelic or Sentry. These solutions are not able to aggregate log messages correctly, when these include unique data - such as event ID or Quote ID.

Event-specific details should be passed as a second attribute (context) of log method.

Before:

After

Related Pull Requests

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

Trigger Checkout failure
Validate log message - It should not include any details

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Log Aggregation fix on Checkout failure (group by reason, not Quote ID) #37879: Log Aggregation fix on Checkout failure (group by reason, not Quote ID)

m2-assistant · 2023-08-10T09:24:08Z

Hi @lbajsarowicz. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

lbajsarowicz · 2023-08-10T09:29:25Z

@magento run all tests

magento-automated-testing · 2023-08-10T09:29:33Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

convenient · 2023-08-10T09:32:16Z

sorry went on autopilot there and approved rather than 👍 😅

michalbiarda

I like this change. I left in comments some ideas for further improvements.

app/code/Magento/Checkout/Model/GuestPaymentInformationManagement.php

app/code/Magento/Checkout/Model/PaymentInformationManagement.php

lbajsarowicz · 2023-08-10T15:20:59Z

@magento run all tests

magento-automated-testing · 2023-08-10T15:21:09Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

tdgroot

👍

engcom-Lima · 2023-08-16T10:00:11Z

@magento create issue

ihor-sviziev

✔ Approved.

Failing tests look not related to changes from this PR.

engcom-Echo · 2023-08-25T02:36:26Z

@magento run all tests

magento-automated-testing · 2023-08-25T02:36:32Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-28T06:36:03Z

@magento run all tests

magento-automated-testing · 2023-08-28T06:36:10Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-28T06:41:28Z

✔️ QA Passed

Manual testing scenario:

Trigger Checkout failure
Validate log message - It should not include any details

Before: ✖️

After: ✔️

There are build failure, Hence moving it to Extended Testing

engcom-Echo · 2023-08-28T08:29:59Z

@magento run Functional Tests EE,Functional Tests CE,Integration Tests

magento-automated-testing · 2023-08-28T08:30:15Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-28T08:44:02Z

@magento run Functional Tests B2B

magento-automated-testing · 2023-08-28T08:44:10Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-28T08:45:49Z

@magento run Functional Tests B2B

magento-automated-testing · 2023-08-28T08:45:55Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-28T11:06:03Z

Functional Tests B2B and Functional Tests EE build are green.Functional Tests CE failure are different on last two run.
Run1

Run2

Hence moving to merge in progress

Log Aggregation fix on Checkout failure (group by reason, not Quote ID)

adfbda3

m2-community-project bot added the Progress: pending review label Aug 10, 2023

convenient approved these changes Aug 10, 2023

View reviewed changes

m2-community-project bot assigned convenient Aug 10, 2023

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Aug 10, 2023

convenient removed their assignment Aug 10, 2023

m2-community-project bot added Progress: pending review and removed Progress: ready for testing labels Aug 10, 2023

michalbiarda reviewed Aug 10, 2023

View reviewed changes

app/code/Magento/Checkout/Model/GuestPaymentInformationManagement.php Show resolved Hide resolved

app/code/Magento/Checkout/Model/PaymentInformationManagement.php Show resolved Hide resolved

m2-community-project bot added Progress: review Progress: pending review and removed Progress: pending review Progress: review labels Aug 10, 2023

Add is_guest_checkout to the log context

0249bd6

tdgroot approved these changes Aug 11, 2023

View reviewed changes

m2-community-project bot assigned tdgroot Aug 11, 2023

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Aug 11, 2023

m2-assistant bot mentioned this pull request Aug 16, 2023

[Issue] Log Aggregation fix on Checkout failure (group by reason, not Quote ID) #37879

Closed

5 tasks

engcom-Lima self-assigned this Aug 16, 2023

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Aug 16, 2023

m2-community-project bot added the Progress: review label Aug 21, 2023

ihor-sviziev approved these changes Aug 21, 2023

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: review labels Aug 21, 2023

Merge branch '2.4-develop' into log-aggregation-1

59c5dba

engcom-Echo self-assigned this Aug 25, 2023

m2-community-project bot added Progress: testing in progress Progress: ready for testing and removed Progress: ready for testing Progress: testing in progress labels Aug 25, 2023

Merge branch '2.4-develop' into log-aggregation-1

8d8772b

m2-community-project bot added Progress: testing in progress Progress: extended testing and removed Progress: ready for testing Progress: testing in progress labels Aug 28, 2023

m2-community-project bot added Progress: accept and removed Progress: extended testing labels Aug 28, 2023

magento-devops-reposync-svc merged commit dc3fc81 into magento:2.4-develop Aug 31, 2023

Log Aggregation fix on Checkout failure (group by reason, not Quote ID) #37871

Log Aggregation fix on Checkout failure (group by reason, not Quote ID) #37871

Uh oh!

Conversation

lbajsarowicz commented Aug 10, 2023 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Aug 10, 2023

Uh oh!

lbajsarowicz commented Aug 10, 2023

Uh oh!

magento-automated-testing bot commented Aug 10, 2023

Uh oh!

convenient commented Aug 10, 2023

Uh oh!

michalbiarda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lbajsarowicz commented Aug 10, 2023

Uh oh!

magento-automated-testing bot commented Aug 10, 2023

Uh oh!

tdgroot left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Lima commented Aug 16, 2023

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Echo commented Aug 25, 2023

Uh oh!

magento-automated-testing bot commented Aug 25, 2023

Uh oh!

engcom-Echo commented Aug 28, 2023

Uh oh!

magento-automated-testing bot commented Aug 28, 2023

Uh oh!

engcom-Echo commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ QA Passed

Uh oh!

engcom-Echo commented Aug 28, 2023

Uh oh!

magento-automated-testing bot commented Aug 28, 2023

Uh oh!

engcom-Echo commented Aug 28, 2023

Uh oh!

magento-automated-testing bot commented Aug 28, 2023

Uh oh!

engcom-Echo commented Aug 28, 2023

Uh oh!

magento-automated-testing bot commented Aug 28, 2023

Uh oh!

engcom-Echo commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

lbajsarowicz commented Aug 10, 2023 •

edited by m2-assistant bot

Loading

engcom-Echo commented Aug 28, 2023 •

edited

Loading

engcom-Echo commented Aug 28, 2023 •

edited

Loading