Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ease of use debugging #5850

Merged
merged 7 commits into from
Aug 30, 2024

Conversation

cyberhck
Copy link
Contributor

@cyberhck cyberhck commented Aug 20, 2024

When we want to use debug mode, we can only get 1 file per node in Kubernetes, this change allows us to do 2 things:

  • set restartPolicy of pod as desired.
  • add hostname in path for collecting healtrack data.

Fixes #5789


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@cyberhck cyberhck requested a review from a team as a code owner August 20, 2024 07:47
@cyberhck cyberhck force-pushed the nishchal/ease-of-use-debugging branch from 5aa4358 to 9f7d9d2 Compare August 20, 2024 07:48
@cyberhck
Copy link
Contributor Author

@garypen let me know if there's any more change you would like.

@cyberhck
Copy link
Contributor Author

@garypen @BrynCooke please let me know anything else that I need to do to get this merged.

@bnjjj bnjjj requested a review from garypen August 22, 2024 15:19
@cyberhck
Copy link
Contributor Author

let me know if you'd like me to rebase this branch with latest dev branch.

@garypen garypen self-assigned this Aug 23, 2024
Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, it's much appreciated.

If we make this change, it may be a little surprising to users, since their output heaptrack data files will now have a hostname in them. I don't think that's a big deal, since we aren't offering any guarantees about the stability of output debug file names. However, I would like this to be called out explicitly in the changelog.

Once you decide exactly which format of output file name to use, please update the changelog so that it has an example that illustrates the impact of the change.

dockerfiles/Dockerfile.router Outdated Show resolved Hide resolved
@cyberhck cyberhck force-pushed the nishchal/ease-of-use-debugging branch from 3b58e8e to cfbd991 Compare August 29, 2024 10:01
@cyberhck
Copy link
Contributor Author

@garypen does this look better? Sorry about the text in changeset, English is my second language. But if you suggest something, I'll use it.

@garypen
Copy link
Contributor

garypen commented Aug 29, 2024

@garypen does this look better? Sorry about the text in changeset, English is my second language. But if you suggest something, I'll use it.

Looks great! Thanks for pushing this forward.

@garypen garypen self-requested a review August 29, 2024 13:45
Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

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

Thanks very much for the contribution!

@cyberhck
Copy link
Contributor Author

@garypen not sure why CI is failing, anything I can do to help?

@garypen
Copy link
Contributor

garypen commented Aug 30, 2024

@garypen not sure why CI is failing, anything I can do to help?

It's an issue relating to a test which won't work for external contributions. I'm going to merge your PR without waiting for the tests to pass. It's a change that won't impact any of our tests anyway...

@garypen garypen enabled auto-merge (squash) August 30, 2024 13:48
@garypen garypen disabled auto-merge August 30, 2024 16:14
@garypen garypen merged commit 1f87295 into apollographql:dev Aug 30, 2024
7 of 13 checks passed
@cyberhck cyberhck deleted the nishchal/ease-of-use-debugging branch September 2, 2024 03:04
@abernix abernix mentioned this pull request Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ease of use: debug mode
2 participants