Skip to content

[Issue] Add GraphQL New Relic transaction naming #40455

@m2-assistant

Description

@m2-assistant

This issue is automatically created based on existing pull request: #40452: Add GraphQL New Relic transaction naming


Description (*)

This pull request implements detailed New Relic transaction naming for GraphQL requests, mirroring the functionality of the JomaShop module. It introduces a new helper and a QueryProcessor plugin to set specific transaction names based on the GraphQL operation type, operation name, and top-level fields. Custom parameters for the number of fields and field names are also added to New Relic.

This change enhances observability by providing more granular and informative transaction data for GraphQL queries and mutations, improving performance monitoring and debugging. The default transaction naming in Magento\GraphQlNewRelic\Model\Query\Logger\NewRelic has been disabled to prevent overwriting the more detailed names set by this new plugin.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. Enable New Relic reporting: Ensure New Relic integration is configured and enabled in your Magento instance.
  2. Perform a simple GraphQL query:
    • Example: query { products { total_count } }
    • Verify in New Relic that the transaction name is similar to GraphQL-products.
    • Check for custom parameters: GraphqlNumberOfFields (e.g., 1) and FieldNames (e.g., products).
  3. Perform a GraphQL query with an explicit operation name:
    • Example: query MyProducts { products { total_count } }
    • Verify in New Relic that the transaction name is similar to GraphQL-MyProducts.
  4. Perform a GraphQL query with multiple top-level fields:
    • Example: query { products { total_count } categories { items { name } } }
    • Verify in New Relic that the transaction name is similar to GraphQL-Multiple.
  5. Perform a GraphQL mutation (if applicable):
    • Example: mutation { createCart { cart { id } } }
    • Verify in New Relic that the transaction name reflects the mutation type and operation, e.g., GraphQL-createCart.

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Priority: P3May be fixed according to the position in the backlog.

    Type

    No type

    Projects

    Status

    Ready for Development

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions