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

Please detail a tested, valid, real world example of a log search alert webhook body #6698

Closed
willmorgan opened this issue Apr 4, 2018 — with docs.microsoft.com · 11 comments

Comments

Copy link
Contributor

Both documentation examples are invalid JSON and are of different data shapes. Notably, the format of the webhook appears to be different to that of standard Azure Alerts.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@femsulu
Copy link
Member

femsulu commented Apr 4, 2018

@willmorgan Thanks for the comment. Your feedback has been shared with the content owner. We will get back to you shortly.

@msvijayn
Copy link
Contributor

msvijayn commented Apr 5, 2018

@willmorgan Kindly elaborate what the issue you're seeing with the webhook from Log Alerts. The webhook samples shown in doc, are indicative of real-world output you'll get using custom log search based Azure Alerts for Application Insights app or Log Analytics workspace chosen.

Since these are query based alerts, their format can not be same as metric alerts. Both log alerts and metric alerts are part of Azure Alerts and usable from Azure Monitor - Alerts section.

@willmorgan
Copy link
Contributor Author

@msvijayn If you copy a few of those examples into an IDE or JSON validator you'll see that the JSON isn't valid. To me this suggests that these aren't the real output of what the webhook sends.

@msvijayn
Copy link
Contributor

msvijayn commented Apr 9, 2018

@willmorgan thanks, for the clarification. Yes, you are right the webhook provided aren't meeting JSON RFC 4627 validation. I am updating the doc with correction.

PR #37346

@msvijayn
Copy link
Contributor

msvijayn commented Apr 9, 2018

#in-progress

@msvijayn
Copy link
Contributor

msvijayn commented Apr 10, 2018

PR has merged and doc has been updated

@msvijayn
Copy link
Contributor

msvijayn commented Apr 10, 2018

@femsulu @willmorgan #please-close

@willmorgan
Copy link
Contributor Author

Thanks @msvijayn. Just to confirm, this is captured from a real webhook request sent from Azure, right?

@msvijayn
Copy link
Contributor

@willmorgan Yes, it is a real webhook sent from log alerts; abet minor changes to replace critical data like subscription and search result URL - with dummy values for documentation use.

@willmorgan
Copy link
Contributor Author

Okay, just making sure, because the indentation looks like it's been through an IDE or something 🙂

Thanks for confirming.

@msvijayn
Copy link
Contributor

msvijayn commented Apr 10, 2018

@willmorgan - Ooh, yes I have done indentation - as its a mandate for readability in docs. In real world, you'll get the webhook as a continual JSON payload with no such indentation.

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

No branches or pull requests

3 participants