Forum Discussion
Noa Kuperberg
Microsoft
MicrosoftSurvey: Adding query examples to the Logs UX
Hi!
We’re adding query examples to the Logs pages of various Azure resources (such as Key Vaults and Stream Analytics), to help users get started easily, and find meaningful data and insights. Which would you prefer?
- Queries’ titles can be phrased as:
A question: “How many requests failed over the last day?”
A statement: “List all failed requests over the last day”.
Which is better?
- Similar examples (such as calculating average vs median, or bins of 1 hour vs 1 day) can be shown as:
Two separate examples (each with its own title and description)
One example with a comment in it, explaining a possible modification (such as “replace this value to 1d to run per day instead of hour”)
Which is better?
- Statements are better as they dictate what the results are.
One example with comments--in fact, all query examples should include basic comments, specifically before query statements that are more complex than standard "where" operators.
1 Reply
- Statements are better as they dictate what the results are.
One example with comments--in fact, all query examples should include basic comments, specifically before query statements that are more complex than standard "where" operators.