Skip to content

[TT-11388]: updated opentelemtry library and added tests for new span keys#6087

Merged
kofoworola merged 1 commit into
masterfrom
fix/TT-11388/fix-graphql-spans
Mar 4, 2024
Merged

[TT-11388]: updated opentelemtry library and added tests for new span keys#6087
kofoworola merged 1 commit into
masterfrom
fix/TT-11388/fix-graphql-spans

Conversation

@kofoworola

@kofoworola kofoworola commented Mar 1, 2024

Copy link
Copy Markdown
Contributor

User description

Description

updated opentelemtry library and added tests for new span keys
TT-11388

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

  • I ensured that the documentation is up to date
  • I explained why this PR updates go.mod in detail with reasoning why it's required
  • I would like a code coverage CI quality gate exception and have explained why

Type

enhancement, tests


Description

  • Updated OpenTelemetry library to version v0.0.21.
  • Enhanced GraphQL tracing scenarios by including operation names in the query body.
  • Added new assertions to validate GraphQL span attributes, ensuring the correct tracking of GraphQL operations.

Changes walkthrough

Relevant files
Enhancement
tyk_test-graphql-detailed-tracing-disabled_200.yaml
Update GraphQL Tracing Scenario and Assertions                     

ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml

  • Updated the GraphQL query body to include an operation name.
  • Added assertions to validate new span attributes for GraphQL
    operations.
  • +8/-2     
    tyk_test-graphql-tracing_200.yml
    Enhance GraphQL Tracing Tests with New Span Attributes     

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml

  • Modified the GraphQL query to include an operation name.
  • Added assertions for new GraphQL span attributes.
  • +7/-2     
    Dependencies
    go.mod
    Update OpenTelemetry Library Dependency                                   

    go.mod

  • Updated github.com/TykTechnologies/opentelemetry to version v0.0.21.
  • +1/-1     
    go.sum
    Update Checksum for OpenTelemetry Dependency                         

    go.sum

  • Updated checksum for github.com/TykTechnologies/opentelemetry to
    v0.0.21.
  • +2/-2     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @kofoworola
    kofoworola requested a review from a team as a code owner March 1, 2024 15:49
    @kofoworola
    kofoworola requested review from buraksezer, pvormste and rhianeKobar and removed request for a team and buraksezer March 1, 2024 15:49
    @github-actions

    github-actions Bot commented Mar 1, 2024

    Copy link
    Copy Markdown
    Contributor

    API Changes

    no api changes detected

    @github-actions

    github-actions Bot commented Mar 1, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Description updated to latest commit (3922caf)

    @github-actions

    github-actions Bot commented Mar 1, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are focused on updating dependencies and adding specific tests for new functionality. The scope is narrow and the changes are well-defined, making the review process straightforward.

    🧪 Relevant tests

    Yes

    🔍 Possible issues

    The updated tests now include operationName in the GraphQL queries. Ensure that the backend correctly supports and utilizes this additional field without affecting existing functionality.

    The update to the opentelemetry library (github.com/TykTechnologies/opentelemetry v0.0.21) should be checked for any breaking changes or major updates that could affect the tracing functionality.

    🔒 Security concerns

    No

    Code feedback:
    relevant fileci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml
    suggestion      

    Ensure that the added operationName in the GraphQL query does not introduce any unexpected behavior or errors in the backend processing. This change might require additional validation or handling in the GraphQL engine to properly utilize the operationName. [important]

    relevant linebody: "{\n \"query\": \"query test {\\n country(code: \\\"NG\\\"){\\n name\\n }\\n}\",\n \"operationName\": \"test\"\n}"

    relevant filego.mod
    suggestion      

    Verify the compatibility and review the changelog of github.com/TykTechnologies/opentelemetry v0.0.21 to ensure that the update does not introduce any breaking changes or regressions in tracing functionality. It's important to test the tracing thoroughly after this library update. [important]

    relevant linegithub.com/TykTechnologies/opentelemetry v0.0.21


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
    When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    

    With a configuration file, use the following template:

    [pr_reviewer]
    some_config1=...
    some_config2=...
    
    Utilizing extra instructions

    The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

    Examples for extra instructions:

    [pr_reviewer] # /review #
    extra_instructions="""
    In the 'possible issues' section, emphasize the following:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    How to enable\disable automation
    • When you first install PR-Agent app, the default mode for the review tool is:
    pr_commands = ["/review", ...]
    

    meaning the review tool will run automatically on every PR, with the default configuration.
    Edit this field to enable/disable the tool, or to change the used configurations

    Auto-labels

    The review tool can auto-generate two specific types of labels for a PR:

    • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
    • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
    Extra sub-tools

    The review tool provides a collection of possible feedbacks about a PR.
    It is recommended to review the possible options, and choose the ones relevant for your use case.
    Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
    require_score_review, require_soc2_ticket, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve
    

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
    enable_auto_approval = true
    

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
    maximal_review_effort = 5
    
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the review usage page for a comprehensive guide on using this tool.

    @github-actions

    github-actions Bot commented Mar 1, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Simplify the JSON format in the body field for better readability.

    Consider using a more compact and readable JSON format for the body field by removing
    unnecessary line breaks and escape characters.

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml [11]

    -body: "{\n  \"query\": \"query test {\\n  country(code: \\\"NG\\\"){\\n    name\\n  }\\n}\",\n  \"operationName\": \"test\"\n}"
    +body: '{"query": "query test { country(code: \"NG\"){ name } }", "operationName": "test"}'
     
    Maintainability
    Use consistent quotation marks for string values.

    Ensure consistency in the use of quotes for string values in assertions to improve
    readability.

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml [29]

    -- "attr:graphql.document = 'query test {\n  country(code: \"NG\"){\n    name\n  }\n}'"
    +- attr:graphql.document = "query test {\n  country(code: \"NG\"){\n    name\n  }\n}"
     
    Best practice
    Improve spacing around equals sign for consistency.

    Align the spacing around the equals sign in assertions for better readability and
    consistency.

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml [37-38]

    -- attr:graphql.operation.type     =     "query"
    -- attr:graphql.operation.name     =     "test"
    +- attr:graphql.operation.type = "query"
    +- attr:graphql.operation.name = "test"
     
    Run go mod tidy to clean up the go.sum file.

    After updating dependencies in go.mod, run go mod tidy to clean up the go.sum file and
    remove any unnecessary entries.

    go.sum [62-63]

    -github.com/TykTechnologies/opentelemetry v0.0.21 h1:/ew4NET0nbLKmsNKmuEavTU+Zp3L78LNUb6IsPlbrFU=
    -github.com/TykTechnologies/opentelemetry v0.0.21/go.mod h1:5LkNDN08FYVhSTH0gC3hwk6cH6jP3F8cc5mv2asUHyA=
    +...
     
    Possible issue
    Check compatibility of the updated opentelemetry library.

    Verify the compatibility of the updated github.com/TykTechnologies/opentelemetry library
    version with the project to ensure no breaking changes.

    go.mod [90]

    -github.com/TykTechnologies/opentelemetry v0.0.21
    +...
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    @kofoworola
    kofoworola force-pushed the fix/TT-11388/fix-graphql-spans branch from 3922caf to e578a6d Compare March 1, 2024 15:57
    @sonarqubecloud

    sonarqubecloud Bot commented Mar 1, 2024

    Copy link
    Copy Markdown

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

    Measures
    0 Security Hotspots
    No data about Coverage
    0.0% Duplication on New Code

    See analysis details on SonarCloud

    @buger

    buger commented Mar 1, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - postgres15-sha256 env: success
    Branch used: refs/heads/master
    Commit: 8b3b2f0 TT-11388: updated opentelemtry library and added tests for new span keys (#6087)

    User description

    Description

    updated opentelemtry library and added tests for new span keys
    TT-11388

    Related Issue

    Motivation and Context

    How This Has Been Tested

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Updated OpenTelemetry library to version v0.0.21.
    • Enhanced GraphQL tracing scenarios by including operation names in the
      query body.
    • Added new assertions to validate GraphQL span attributes, ensuring the
      correct tracking of GraphQL operations.

    Changes walkthrough

    Relevant files
    Enhancement
    tyk_test-graphql-detailed-tracing-disabled_200.yaml
    Update GraphQL Tracing Scenario and Assertions                     

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml

  • Updated the GraphQL query body to include an operation name.
  • Added assertions to validate new span attributes for GraphQL
    operations.
  • +8/-2     
    tyk_test-graphql-tracing_200.yml
    Enhance GraphQL Tracing Tests with New Span Attributes     

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml

  • Modified the GraphQL query to include an operation name.
  • Added assertions for new GraphQL span attributes.
  • +7/-2     
    Dependencies
    go.mod
    Update OpenTelemetry Library Dependency                                   

    go.mod

  • Updated github.com/TykTechnologies/opentelemetry to version v0.0.21.
  • +1/-1     
    go.sum
    Update Checksum for OpenTelemetry Dependency                         

    go.sum

  • Updated checksum for github.com/TykTechnologies/opentelemetry to
    v0.0.21.
  • +2/-2     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions

    Triggered by: push (@kofoworola)
    Execution page

    @buger

    buger commented Mar 1, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - mongo44-sha256 env: success
    Branch used: refs/heads/master
    Commit: 8b3b2f0 TT-11388: updated opentelemtry library and added tests for new span keys (#6087)

    User description

    Description

    updated opentelemtry library and added tests for new span keys
    TT-11388

    Related Issue

    Motivation and Context

    How This Has Been Tested

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Updated OpenTelemetry library to version v0.0.21.
    • Enhanced GraphQL tracing scenarios by including operation names in the
      query body.
    • Added new assertions to validate GraphQL span attributes, ensuring the
      correct tracking of GraphQL operations.

    Changes walkthrough

    Relevant files
    Enhancement
    tyk_test-graphql-detailed-tracing-disabled_200.yaml
    Update GraphQL Tracing Scenario and Assertions                     

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml

  • Updated the GraphQL query body to include an operation name.
  • Added assertions to validate new span attributes for GraphQL
    operations.
  • +8/-2     
    tyk_test-graphql-tracing_200.yml
    Enhance GraphQL Tracing Tests with New Span Attributes     

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml

  • Modified the GraphQL query to include an operation name.
  • Added assertions for new GraphQL span attributes.
  • +7/-2     
    Dependencies
    go.mod
    Update OpenTelemetry Library Dependency                                   

    go.mod

  • Updated github.com/TykTechnologies/opentelemetry to version v0.0.21.
  • +1/-1     
    go.sum
    Update Checksum for OpenTelemetry Dependency                         

    go.sum

  • Updated checksum for github.com/TykTechnologies/opentelemetry to
    v0.0.21.
  • +2/-2     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions

    Triggered by: push (@kofoworola)
    Execution page

    @kofoworola
    kofoworola merged commit 8b3b2f0 into master Mar 4, 2024
    @kofoworola
    kofoworola deleted the fix/TT-11388/fix-graphql-spans branch March 4, 2024 10:36
    @buger

    buger commented Mar 4, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - postgres15-murmur64 env: success
    Branch used: refs/heads/master
    Commit: 8b3b2f0 TT-11388: updated opentelemtry library and added tests for new span keys (#6087)

    User description

    Description

    updated opentelemtry library and added tests for new span keys
    TT-11388

    Related Issue

    Motivation and Context

    How This Has Been Tested

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Updated OpenTelemetry library to version v0.0.21.
    • Enhanced GraphQL tracing scenarios by including operation names in the
      query body.
    • Added new assertions to validate GraphQL span attributes, ensuring the
      correct tracking of GraphQL operations.

    Changes walkthrough

    Relevant files
    Enhancement
    tyk_test-graphql-detailed-tracing-disabled_200.yaml
    Update GraphQL Tracing Scenario and Assertions                     

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml

  • Updated the GraphQL query body to include an operation name.
  • Added assertions to validate new span attributes for GraphQL
    operations.
  • +8/-2     
    tyk_test-graphql-tracing_200.yml
    Enhance GraphQL Tracing Tests with New Span Attributes     

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml

  • Modified the GraphQL query to include an operation name.
  • Added assertions for new GraphQL span attributes.
  • +7/-2     
    Dependencies
    go.mod
    Update OpenTelemetry Library Dependency                                   

    go.mod

  • Updated github.com/TykTechnologies/opentelemetry to version v0.0.21.
  • +1/-1     
    go.sum
    Update Checksum for OpenTelemetry Dependency                         

    go.sum

  • Updated checksum for github.com/TykTechnologies/opentelemetry to
    v0.0.21.
  • +2/-2     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions

    Triggered by: push (@kofoworola)
    Execution page

    @buger

    buger commented Mar 4, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - mongo44-murmur64 env: success
    Branch used: refs/heads/master
    Commit: 8b3b2f0 TT-11388: updated opentelemtry library and added tests for new span keys (#6087)

    User description

    Description

    updated opentelemtry library and added tests for new span keys
    TT-11388

    Related Issue

    Motivation and Context

    How This Has Been Tested

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Updated OpenTelemetry library to version v0.0.21.
    • Enhanced GraphQL tracing scenarios by including operation names in the
      query body.
    • Added new assertions to validate GraphQL span attributes, ensuring the
      correct tracking of GraphQL operations.

    Changes walkthrough

    Relevant files
    Enhancement
    tyk_test-graphql-detailed-tracing-disabled_200.yaml
    Update GraphQL Tracing Scenario and Assertions                     

    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml

  • Updated the GraphQL query body to include an operation name.
  • Added assertions to validate new span attributes for GraphQL
    operations.
  • +8/-2     
    tyk_test-graphql-tracing_200.yml
    Enhance GraphQL Tracing Tests with New Span Attributes     

    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml

  • Modified the GraphQL query to include an operation name.
  • Added assertions for new GraphQL span attributes.
  • +7/-2     
    Dependencies
    go.mod
    Update OpenTelemetry Library Dependency                                   

    go.mod

  • Updated github.com/TykTechnologies/opentelemetry to version v0.0.21.
  • +1/-1     
    go.sum
    Update Checksum for OpenTelemetry Dependency                         

    go.sum

  • Updated checksum for github.com/TykTechnologies/opentelemetry to
    v0.0.21.
  • +2/-2     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions

    Triggered by: push (@kofoworola)
    Execution page

    @kofoworola

    Copy link
    Copy Markdown
    Contributor Author

    /release to release-5.3

    @tykbot

    tykbot Bot commented Mar 7, 2024

    Copy link
    Copy Markdown

    Working on it! Note that it can take a few minutes.

    tykbot Bot pushed a commit that referenced this pull request Mar 7, 2024
    … keys (#6087)
    
    ## **User description**
    <!-- Provide a general summary of your changes in the Title above -->
    
    ## Description
    updated opentelemtry library and added tests for new span keys
    [TT-11388](https://tyktech.atlassian.net/browse/TT-11388)
    
    <!-- Describe your changes in detail -->
    
    ## Related Issue
    
    <!-- This project only accepts pull requests related to open issues. -->
    <!-- If suggesting a new feature or change, please discuss it in an
    issue first. -->
    <!-- If fixing a bug, there should be an issue describing it with steps
    to reproduce. -->
    <!-- OSS: Please link to the issue here. Tyk: please create/link the
    JIRA ticket. -->
    
    ## Motivation and Context
    
    <!-- Why is this change required? What problem does it solve? -->
    
    ## How This Has Been Tested
    
    <!-- Please describe in detail how you tested your changes -->
    <!-- Include details of your testing environment, and the tests -->
    <!-- you ran to see how your change affects other areas of the code,
    etc. -->
    <!-- This information is helpful for reviewers and QA. -->
    
    ## Screenshots (if appropriate)
    
    ## Types of changes
    
    <!-- What types of changes does your code introduce? Put an `x` in all
    the boxes that apply: -->
    
    - [ ] Bug fix (non-breaking change which fixes an issue)
    - [ ] New feature (non-breaking change which adds functionality)
    - [ ] Breaking change (fix or feature that would cause existing
    functionality to change)
    - [ ] Refactoring or add test (improvements in base code or adds test
    coverage to functionality)
    
    ## Checklist
    
    <!-- Go over all the following points, and put an `x` in all the boxes
    that apply -->
    <!-- If there are no documentation updates required, mark the item as
    checked. -->
    <!-- Raise up any additional concerns not covered by the checklist. -->
    
    - [ ] I ensured that the documentation is up to date
    - [ ] I explained why this PR updates go.mod in detail with reasoning
    why it's required
    - [ ] I would like a code coverage CI quality gate exception and have
    explained why
    
    
    ___
    
    ## **Type**
    enhancement, tests
    
    
    ___
    
    ## **Description**
    - Updated OpenTelemetry library to version `v0.0.21`.
    - Enhanced GraphQL tracing scenarios by including operation names in the
    query body.
    - Added new assertions to validate GraphQL span attributes, ensuring the
    correct tracking of GraphQL operations.
    
    
    ___
    
    
    
    ## **Changes walkthrough**
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    
    <summary><strong>tyk_test-graphql-detailed-tracing-disabled_200.yaml</strong><dd><code>Update
    GraphQL Tracing Scenario and Assertions</code>&nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    
    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml
    <li>Updated the GraphQL query body to include an operation name.<br>
    <li> Added assertions to validate new span attributes for GraphQL
    <br>operations.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-77005f007390131ed92b45a70093403c4e3bece1b4b04607d2655393054c9ed2">+8/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
    
    <summary><strong>tyk_test-graphql-tracing_200.yml</strong><dd><code>Enhance
    GraphQL Tracing Tests with New Span Attributes</code>&nbsp; &nbsp;
    &nbsp; </dd></summary>
    <hr>
    
    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml
    <li>Modified the GraphQL query to include an operation name.<br> <li>
    Added assertions for new GraphQL span attributes.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-2df94df431a444a3778f2b00fd47d911dcfa2e0c9c883de72f72adcd509c890a">+7/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    </table></td></tr><tr><td><strong>Dependencies</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>go.mod</strong><dd><code>Update OpenTelemetry Library
    Dependency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    </dd></summary>
    <hr>
    
    go.mod
    <li>Updated <code>github.com/TykTechnologies/opentelemetry</code> to
    version <code>v0.0.21</code>.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-33ef32bf6c23acb95f5902d7097b7a1d5128ca061167ec0716715b0b9eeaa5f6">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
    <summary><strong>go.sum</strong><dd><code>Update Checksum for
    OpenTelemetry Dependency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    go.sum
    <li>Updated checksum for
    <code>github.com/TykTechnologies/opentelemetry</code> to
    <br><code>v0.0.21</code>.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-3295df7234525439d778f1b282d146a4f1ff6b415248aaac074e8042d9f42d63">+2/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > ✨ **PR-Agent usage**:
    >Comment `/help` on the PR to get a list of all available PR-Agent tools
    and their descriptions
    
    
    
    [TT-11388]:
    https://tyktech.atlassian.net/browse/TT-11388?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
    
    (cherry picked from commit 8b3b2f0)
    buger added a commit that referenced this pull request Mar 7, 2024
    …added tests for new span keys (#6087)
    
    [TT-11388]: updated opentelemtry library and added tests for new span keys (#6087)
    
    ## **User description**
    <!-- Provide a general summary of your changes in the Title above -->
    
    ## Description
    updated opentelemtry library and added tests for new span keys
    [TT-11388](https://tyktech.atlassian.net/browse/TT-11388)
    
    <!-- Describe your changes in detail -->
    
    ## Related Issue
    
    <!-- This project only accepts pull requests related to open issues. -->
    <!-- If suggesting a new feature or change, please discuss it in an
    issue first. -->
    <!-- If fixing a bug, there should be an issue describing it with steps
    to reproduce. -->
    <!-- OSS: Please link to the issue here. Tyk: please create/link the
    JIRA ticket. -->
    
    ## Motivation and Context
    
    <!-- Why is this change required? What problem does it solve? -->
    
    ## How This Has Been Tested
    
    <!-- Please describe in detail how you tested your changes -->
    <!-- Include details of your testing environment, and the tests -->
    <!-- you ran to see how your change affects other areas of the code,
    etc. -->
    <!-- This information is helpful for reviewers and QA. -->
    
    ## Screenshots (if appropriate)
    
    ## Types of changes
    
    <!-- What types of changes does your code introduce? Put an `x` in all
    the boxes that apply: -->
    
    - [ ] Bug fix (non-breaking change which fixes an issue)
    - [ ] New feature (non-breaking change which adds functionality)
    - [ ] Breaking change (fix or feature that would cause existing
    functionality to change)
    - [ ] Refactoring or add test (improvements in base code or adds test
    coverage to functionality)
    
    ## Checklist
    
    <!-- Go over all the following points, and put an `x` in all the boxes
    that apply -->
    <!-- If there are no documentation updates required, mark the item as
    checked. -->
    <!-- Raise up any additional concerns not covered by the checklist. -->
    
    - [ ] I ensured that the documentation is up to date
    - [ ] I explained why this PR updates go.mod in detail with reasoning
    why it's required
    - [ ] I would like a code coverage CI quality gate exception and have
    explained why
    
    
    ___
    
    ## **Type**
    enhancement, tests
    
    
    ___
    
    ## **Description**
    - Updated OpenTelemetry library to version `v0.0.21`.
    - Enhanced GraphQL tracing scenarios by including operation names in the
    query body.
    - Added new assertions to validate GraphQL span attributes, ensuring the
    correct tracking of GraphQL operations.
    
    
    ___
    
    
    
    ## **Changes walkthrough**
    <table><thead><tr><th></th><th align="left">Relevant
    files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
    <tr>
      <td>
        <details>
    
    <summary><strong>tyk_test-graphql-detailed-tracing-disabled_200.yaml</strong><dd><code>Update
    GraphQL Tracing Scenario and Assertions</code>&nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    
    ci/tests/tracing/scenarios/tyk_test-graphql-detailed-tracing-disabled_200.yaml
    <li>Updated the GraphQL query body to include an operation name.<br>
    <li> Added assertions to validate new span attributes for GraphQL
    <br>operations.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-77005f007390131ed92b45a70093403c4e3bece1b4b04607d2655393054c9ed2">+8/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
    
    <summary><strong>tyk_test-graphql-tracing_200.yml</strong><dd><code>Enhance
    GraphQL Tracing Tests with New Span Attributes</code>&nbsp; &nbsp;
    &nbsp; </dd></summary>
    <hr>
    
    ci/tests/tracing/scenarios/tyk_test-graphql-tracing_200.yml
    <li>Modified the GraphQL query to include an operation name.<br> <li>
    Added assertions for new GraphQL span attributes.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-2df94df431a444a3778f2b00fd47d911dcfa2e0c9c883de72f72adcd509c890a">+7/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    </table></td></tr><tr><td><strong>Dependencies</strong></td><td><table>
    <tr>
      <td>
        <details>
    <summary><strong>go.mod</strong><dd><code>Update OpenTelemetry Library
    Dependency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    </dd></summary>
    <hr>
    
    go.mod
    <li>Updated <code>github.com/TykTechnologies/opentelemetry</code> to
    version <code>v0.0.21</code>.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-33ef32bf6c23acb95f5902d7097b7a1d5128ca061167ec0716715b0b9eeaa5f6">+1/-1</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    
    <tr>
      <td>
        <details>
    <summary><strong>go.sum</strong><dd><code>Update Checksum for
    OpenTelemetry Dependency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
    &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
    <hr>
    
    go.sum
    <li>Updated checksum for
    <code>github.com/TykTechnologies/opentelemetry</code> to
    <br><code>v0.0.21</code>.
    
    
    </details>
        
    
      </td>
    <td><a
    href="https://github.com/TykTechnologies/tyk/pull/6087/files#diff-3295df7234525439d778f1b282d146a4f1ff6b415248aaac074e8042d9f42d63">+2/-2</a>&nbsp;
    &nbsp; &nbsp; </td>
    </tr>                    
    </table></td></tr></tr></tbody></table>
    
    ___
    
    > ✨ **PR-Agent usage**:
    >Comment `/help` on the PR to get a list of all available PR-Agent tools
    and their descriptions
    
    
    
    [TT-11388]:
    https://tyktech.atlassian.net/browse/TT-11388?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
    @tykbot

    tykbot Bot commented Mar 7, 2024

    Copy link
    Copy Markdown

    @kofoworola Succesfully merged PR

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants