aesiniath / unbeliever

Opinionated Haskell Interoperability
https://hackage.haskell.org/package/unbeliever
MIT License
33 stars 11 forks source link

Add some documentation about missing Honeycomb spans #163

Closed dmvianna closed 1 year ago

dmvianna commented 1 year ago

This PR adds a little Gotchas section to Core.Telemetry.Honeycomb to alert users that if they see a (missing) span in the Honeycomb UI, it may be just that that span hasn't finished executing yet.

dmvianna commented 1 year ago

About

it is best to call beginTrace inside a function that will iterate continuously

I left the root span below the iteration in a long lived process overnight. I just killed it in the morning. Now I have a single trace and no good way of finding which span gave me the error I'm interested in, and which I can clearly see in the graphs.

image

image

In short, in this case, putting the root high in the hierarchy was a bad idea.