# `Shardex.Telemetry`
[🔗](https://github.com/epinault/shardex/blob/v0.1.0/lib/shardex/telemetry.ex#L1)

Telemetry events emitted by Shardex. Every event's metadata includes `:instance`.

  * `[:shardex, :route, :start | :stop | :exception]` - span around strategy routing.
    Always emitted for batches; for single keys only when the strategy's `trace?/0`
    is `true`. Stop measurements include `:key_count`. Metadata: `:strategy`, `:batch?`.
  * `[:shardex, :run, :start | :stop | :exception]` - span around the function run
    against a pool. Metadata: `:shard`, `:role`.
  * `[:shardex, :batch, :stop]` - after grouping. Measurements: `:duration`, `:items`,
    `:groups`, `:errors`.
  * `[:shardex, :shard, :status_changed]` - Metadata: `:shard`, `:role` (`nil` for the
    whole shard), `:from`, `:to`.
  * `[:shardex, :topology, :changed]` - Metadata: `:action` (`:add | :remove`), `:shard`,
    `:version`.
  * `[:shardex, :coordinator, :init]` - the Coordinator finished booting, at instance start
    and again after a crash restart (which rebuilds state from the boot config, dropping
    runtime changes). Measurements: `%{}`. Metadata: `:version` (always `1`).

---

*Consult [api-reference.md](api-reference.md) for complete listing*