feat(client): Add client network configuration for ICMP endpoint clients #661
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Done ✌️ |
TwiN
approved these changes
Feb 4, 2024
TwiN
requested changes
Feb 4, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #661 +/- ##
==========================================
+ Coverage 78.51% 78.57% +0.05%
==========================================
Files 58 58
Lines 4748 4746 -2
==========================================
+ Hits 3728 3729 +1
+ Misses 833 831 -2
+ Partials 187 186 -1 ☔ View full report in Codecov by Sentry. |
TwiN
approved these changes
Feb 7, 2024
TwiN
reviewed
Feb 7, 2024
TwiN
approved these changes
Feb 7, 2024
TwiN
approved these changes
Feb 7, 2024
|
Thank you for the contribution! |
github-merge-queue bot
pushed a commit
to chezmoi-sh/nex.rpi
that referenced
this pull request
Mar 23, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | OpenSSF | |---|---|---|---| | [TwiN/gatus](https://togithub.com/TwiN/gatus) | minor | `v5.7.0` -> `v5.8.0` | [](https://securityscorecards.dev/viewer/?uri=github.com/TwiN/gatus) | --- ### Release Notes <details> <summary>TwiN/gatus (TwiN/gatus)</summary> ### [`v5.8.0`](https://togithub.com/TwiN/gatus/releases/tag/v5.8.0) [Compare Source](https://togithub.com/TwiN/gatus/compare/v5.7.0...v5.8.0) ##### What's Changed - feat(client): Add Google's Identity-Aware-Proxy in client config by [@​Kloox](https://togithub.com/Kloox) in [TwiN/gatus#600 - feat(client): Add client network configuration for ICMP endpoint clients by [@​n-thumann](https://togithub.com/n-thumann) in [TwiN/gatus#661 - feat(http): enhance HTTP client configuration with proxy support by [@​appleboy](https://togithub.com/appleboy) in [TwiN/gatus#668 - feat: add ability to delay startup by [@​vax-r](https://togithub.com/vax-r) in [TwiN/gatus#631 - feat: shields.io endpoint badge by [@​buroa](https://togithub.com/buroa) in [TwiN/gatus#652 - fix(web): Allow configuration of read-buffer-size by [@​TwiN](https://togithub.com/TwiN) in [TwiN/gatus#675 - fix: Allow binding IPv6 addresses for web by [@​n-thumann](https://togithub.com/n-thumann) in [TwiN/gatus#650 - build: refine Makefile targets and build command by [@​appleboy](https://togithub.com/appleboy) in [TwiN/gatus#666 - refactor(alerting): Use pointer for receiver in AlertProvider.GetDefaultAlert method by [@​TwiN](https://togithub.com/TwiN) in [TwiN/gatus#676 - docs(alerting): Fix wrong gitlab terminology (alert key vs. PAT) by [@​salim-b](https://togithub.com/salim-b) in [TwiN/gatus#694 - chore(deps): bump actions/setup-go from 4 to 5 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#634 - chore(deps): bump golang.org/x/crypto from 0.14.0 to 0.18.0 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#649 - chore(deps): bump modernc.org/sqlite from 1.26.0 to 1.28.0 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#654 - chore(deps): bump codecov/codecov-action from 3.1.4 to 3.1.6 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#669 - chore(deps): bump codecov/codecov-action from 3.1.6 to 4.0.1 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#671 - chore(deps): bump github.com/prometheus/client_golang from 1.17.0 to 1.18.0 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#658 - chore(deps): bump github.com/gofiber/fiber/v2 from 2.49.2 to 2.52.1 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#682 - chore(deps): bump github.com/TwiN/deepmerge from 0.2.0 to 0.2.1 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#684 - chore(deps): bump golang.org/x/oauth2 from 0.13.0 to 0.18.0 by [@​dependabot](https://togithub.com/dependabot) in [TwiN/gatus#701 ##### New Contributors - [@​Kloox](https://togithub.com/Kloox) made their first contribution in [TwiN/gatus#600 - [@​n-thumann](https://togithub.com/n-thumann) made their first contribution in [TwiN/gatus#650 - [@​buroa](https://togithub.com/buroa) made their first contribution in [TwiN/gatus#652 **Full Changelog**: TwiN/gatus@v5.7.0...v5.8.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/chezmoi-sh/nex.rpi). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjI2MS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
](https://renovatebot.com){kind=link}
This was referenced Apr 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support to explicitly specify the network to use for ICMP endpoint clients, e.g. IPv6.
In the future, this may be extended to also support HTTPS endpoints (requested #185).
Details
I decided to use
ping.NewPingerinstead ofping.New, because the latter automatically resolves the address before we can set the desired network.I set
ipas the default config value. This is technically not needed and could be an empty string, becauseSetNetworktakes care of it anyways, but I think it's a cleaner approach.Background
I am running Gatus on an IPv6-only machine. Sadly,
net.ResolveIPAddrstill returns a single IPv4 address, when being asked to resolve a dual-stacked host (see golang/go#28666). Pinging the returned IPv4 address from Gatus will obviously fail on an IPv6-only host.I confirmed this by:
ipv6.google.comas an ICMP endpoint: This works by default on an IPv6-only host, because this target is IPv6-only anywaysgoogle.comas an ICMP endpoint: This doesn't work by default on an IPv6-only host, because this target is dual-stacked and Gatus tries to ping via IPv4. Addingnetwork: "ip6"to the endpoints client config fixes this.Checklist
README.md, if applicable.