Adds one line description and key queries in README

[JBAhire]

• Added one line description for GraphQL service.
• Added queries section which lists key queries across main screens including:
  • Get all traces in provided time range
  • Find trace using TraceID
  • Get all services your application is using
  • Get all backends your application is using
  • Get all API's your application is using
  • Get service and backend dependency graph

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (main@45a062d). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #21   +/-   ##
=======================================
  Coverage        ?   81.25%           
  Complexity      ?        2           
=======================================
  Files           ?        2           
  Lines           ?       32           
  Branches        ?        0           
=======================================
  Hits            ?       26           
  Misses          ?        6           
  Partials        ?        0           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 45a062d...871bed3. Read the comment docs.

[codefromthecrypt]

Good job, though I must concede the lack of data model seems troubling to reason with. It would be nice to have a link that can describe the models one can return (in a different PR or later)

[codefromthecrypt]

this attribute might not be around I think.

[aaron-steinfeld]

FWIW, I think it's pretty uncommon to use curl to interface with graphql, although of course workable. I would suspect most readers would use a graphql client. That is to say, the curl part of the doc feels like just noise to me and I think we can just document the queries.

[codefromthecrypt]

Until we have a proper user capable api, I think this is better than nothing as currently people use the zipkin or jaeger apis to poke their systems

We will be using the trace ID and the trace in time range ones for testing, so these two are helpful for examples. It took a very long time to even figure these out. I actually was unable to find anyone who used GraphQL before.

Granted some of the ancillary, repetitive queries could easily be grouped up. Ex get entity name: example of api, endpoint, backend. Agree on that for sure.. pruning sounds fine!

[aaron-steinfeld]

Definitely better than nothing! I guess it gets more to the purpose here - if trying to give a one liner sanity check for things like a health check, curl makes sense- everyone has it and can just copy paste.

If trying to actually work with graphql, there are many interactive clients that are much easier to work with and make things discoverable, include the schema etc. So I guess the primitives I'd expect in the docs are the queries more than the curl commands. Anyway, a nit.

[codefromthecrypt]

agree a good follow-up would be to suggest in the README a graphql client for exactly this reason (more idiomatic and discoverable use)

…

On Wed, Aug 26, 2020 at 8:27 AM Aaron Steinfeld ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In README.md <#21 (comment)> : > @@ -9,7 +9,153 @@ `./gradlew run` -## Ports +## Queries +Here are some of the important GraphQL queries: + +### 1. Get all traces in provided time range + +```graphql +curl -s localhost:2020/graphql -H 'Content-Type: application/graphql' -d\ Definitely better than nothing! I guess it gets more to the purpose here - if trying to give a one liner sanity check for things like a health check, curl makes sense- everyone has it and can just copy paste. If trying to actually work with graphql, there are many interactive clients that are much easier to work with and make things discoverable, include the schema etc. So I guess the primitives I'd expect in the docs are the queries more than the curl commands. Anyway, a nit. [image: image] <https://user-images.githubusercontent.com/45047841/91240892-1e215400-e6f8-11ea-9f1e-2004bbaa96ee.png> — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#21 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPVV7U743P7NSFU36ZB33SCRJFTANCNFSM4QKKKKEQ> .