docs(trace): Add example of tags to be used in jaeger #502
Conversation
MichelDiz
requested review from
rderbier,
damonfeldman,
rarvikar and
Rajakavitha1
as code owners
✅ Deploy Preview for dgraph-docs-repo ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| ### Other tags available | ||
|
|
There was a problem hiding this comment.
The OpenTrace information collected by Dgraph and displayed in Jaeger contains various messages and metadata that can also be filtered by tag. Below is a list of information that is in Jaeger as a tag.
There was a problem hiding this comment.
Is that a suggestion of a text to introduce or are you just commenting?
| #### Tag error | ||
|
|
||
| This tag you will filter out based on error status. |
There was a problem hiding this comment.
I think we should give a little more info on what the tag would match. Doing a quick search for "error" annotations I only find it in otrace.Attribute{otrace.BoolAttribute("error", true)} in oracle.go::428, so I think we can say that this will find transactions that encountered an error during the commit operation (vs other internal errors).
There was a problem hiding this comment.
Yeah, This text can be expanded. It is humanly impossible to explain what each tag does and why at the moment. It was hard to find the ones that works. All of those I've tested on my end.
BTW, several messages are random. So I've skipped a bunch of them. They have random IDs, random timestamps, random errors, erros based on predicate(which can be any). So I have added only those who doesn't change over time.
But to explain them I think this is a more deep research. This PR is just a beginning.
| #### Tag status.code | ||
|
|
||
| This tag you will filter out based on status code 0, 1 or 2. |
There was a problem hiding this comment.
Do we know what this code means?
There was a problem hiding this comment.
it is based on unix status code. Shell based I mean. 0 mean successful, 1 and 2 are errors. 2 is in general a panic or something serious.
| available attributes | ||
| ``` | ||
| handleHasFunction, n.proposeAndWait, dgraph.Execute, resolveMutation, |
There was a problem hiding this comment.
I pasted a bunch of these in Jaeger, but did not get results. Is there a particular syntax needed? We should say more about these, such as that certain ones mean a particular thing, or that generally you can go search the code for these to see what they capture.
There was a problem hiding this comment.
Nothing special. You need to run a query in order to see. For example, run a has function and then add this tag
funcName=handleHasFunction
But you have to set to all Operation. Don't filter by operation. Or filter by query.
No description provided.