https://github.com/nfibrokerage/hummingbird
A generic Phoenix plug for automatically sending traces to honeycomb.io
https://github.com/nfibrokerage/hummingbird
library
Last synced: 12 months ago
JSON representation
A generic Phoenix plug for automatically sending traces to honeycomb.io
- Host: GitHub
- URL: https://github.com/nfibrokerage/hummingbird
- Owner: NFIBrokerage
- License: apache-2.0
- Created: 2020-03-31T15:34:14.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T18:51:04.000Z (over 2 years ago)
- Last Synced: 2025-06-30T02:48:46.994Z (about 1 year ago)
- Topics: library
- Language: Elixir
- Homepage:
- Size: 250 KB
- Stars: 5
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hummingbird
A plug to correlate events between services in a ✋ful lines of Elixir.
Given appropriate trace headers, ships an event for router and response calls.
## Use Case
For reasons, you may not have access to configure structured logging and log shipping. If you can control your controller, this might help. It's dangerous out there, take this.
## To Use
```elixir
defmodule YourAppWeb.YourController do
use YourAppWeb, :controller
plug Hummingbird, service_name: "your_service_name"
end
```
and add the `Hummingbird.Telemetry` child to your supervision tree:
```elixir
defmodule YouApp.Application do
# ..
def start(_type, _args) do
children = [
Hummingbird.Telemetry,
# ..
]
Supervisor.start_link(children, strategy: :one_for_one, name: YourApp.Supervisor)
end
# ..
end
```
## Configuration
**Configure OpenCensus**
In your config.exs:
```elixir
# configure opencensus
config :opencensus,
reporters: [{Opencensus.Honeycomb.Reporter, []}],
send_interval_ms: 1000
```
**Set the dataset per environment**
In your dev, prod, exs files:
```elixir
# configure write key per dataset/environment
# we use environment variables to protect the secret. It doesn't matter how you
# set the value. Choose your own adventure.
config :opencensus_honeycomb,
dataset: "your_dataset_name_goes_here",
write_key: "${HONEYCOMB_WRITE_KEY}"
```
## Assumptions
Currently, it looks for `x-b3-spanid` and `x-b3-traceid` headers on incoming request to create the trace.
## Current Example
## Thanks
Wraps around https://github.com/open-telemetry/opentelemetry-erlang