Skip to content

Commit

Permalink
add example screenshot of a trace
Browse files Browse the repository at this point in the history
  • Loading branch information
the-mikedavis committed Feb 4, 2021
1 parent 7eeba0c commit fd15ff8
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,43 @@

An adapter between slipstream telemetry and honeycomb events

## Connection Telemetry

SlipstreamHoneycomb currently captures the only telemetry which Slipstream
emits: connection messages.

These connection messages are fairly low-level and are very quick (usually
a matter of microseconds). Below is an example screenshot of a trace in our
Honeycomb:

![example](guides/connection-example.png)

The long purple bar is the connection, which was open for ~150s in this case.
That came from the `[:slipstream, :connection, :connect, :stop]` event. The
other spans of this connection are `[:slipstream, :connection, :handle,
:stop]`. From top to bottom, we see from the example:

- the initial `handle_continue(:connect, ..`
- the gun connection coming up (`{:gun_up, conn, :http}`)
- the gun upgrade which is decoded into the `%Slipstream.Events.ChannelConnected{}`
event
- a JoinTopic command from the client
- a `:gun_ws` message that decoded into a TopicJoinSucceeded event
- a big push of data from the remote server (decoded to MessageReceived event)

and then much later (~30s), we see:

- a SendHeartbeat command, followed by
- the HeartbeatAcknowledged

(x4). And finally, the parent process exits with a ParentProcessExited event.

## Installation

```elixir
def deps do
[
{:slipstream_honeycomb, "~> 1.0", organization: "cuatro"}
{:slipstream_honeycomb, "~> 0.1", organization: "cuatro"}
]
end
```
Expand Down
Binary file added guides/connection-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fd15ff8

Please sign in to comment.