Provide actionable suggestions for when webhooks are not configured #2849
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
nytian
approved these changes
Jun 13, 2024
jviau
reviewed
Jun 13, 2024
| @@ -1241,7 +1241,9 @@ internal HttpCreationPayload GetInstanceCreationLinks() | |||
|
|
|||
| internal Uri GetWebhookUri() | |||
| { | |||
| return this.webhookUrlProvider?.Invoke() ?? throw new InvalidOperationException("Webhooks are not configured"); | |||
| string errorMessage = "Webhooks are not configured. This may occur if the environment variable `WEBSITE_HOSTNAME` is not set (should be automatically set for Azure Functions). " + | |||
There was a problem hiding this comment.
nit on <ip-address>:<port> - should we instead use something around "URI" wording? So it is more clear it is open to ip-address:port or a DNS name
There was a problem hiding this comment.
Good idea - implemented in commit: 3621b12
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.
We periodically receive questions about apps failing with the following error "Webhooks are not configured". This often occurs when running in K8s environments.
This PR augments our error message to provide guidance on how to work around this error.