bevy_telemetry 0.1.0

bevy swarm diagnostic, event, metric, and telemetry client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

# bevy_fleet 🌍📐📊

[![test](https://github.com/aberration-technology/bevy_fleet/workflows/test/badge.svg)](https://github.com/aberration-technology/bevy_fleet/actions?query=workflow%3Atest)
[![License](https://img.shields.io/github/license/aberration-technology/bevy_fleet)](https://github.com/aberration-technology/bevy_fleet)
[![crates.io](https://img.shields.io/crates/v/bevy_fleet.svg)](https://crates.io/crates/bevy_fleet)


bevy [fleet](https://fleet.aberration.technology) plugin, see the [demo dashboard](https://fleet.aberration.technology/demo) for live telemetry.


## install

```bash
cargo add bevy_fleet
# or Cargo.toml
# bevy_fleet = "0.1"
```


### optional features

- `git-version` - embed git metadata in every payload
- `sysinfo_plugin` - tap Bevy's system info diagnostics
- `bevy_render` - include GPU / adapter details


## what you get

- [x] bevy plugin with async publisher (tokio runtime, never blocks main thread)
- [x] automatic capture of diagnostics + metrics + machine info
- [x] tracing-friendly event collector and panic hook
- [x] production-grade OTLP exporter (official OpenTelemetry pipeline)
- [x] test companion server for local dev (`cargo run -p bevy_fleet_test_server`)
- [x] managed and self-hosted dashboards
- [x] wasm support
- [ ] network diagnostics plugin (e.g. latency, packet loss)
- [ ] authentication
- [ ] fleet performance optimization (e.g. graphics settings tuning)
- [ ] register asset load failure events
- [ ] register render pipeline events (e.g. validation error)


## usage

```rust
use bevy::prelude::*;
use bevy::diagnostic::FrameTimeDiagnosticsPlugin;
use bevy_fleet::{FleetPlugin, FleetConfig};

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(FrameTimeDiagnosticsPlugin)
        .add_plugins(FleetPlugin {
            config: FleetConfig {
                app_id: "example".into(),
                ..Default::default()
            },
        })
        .run();
}
```

### emitting events

Use Bevy's message API to write Fleet events from any system:

```rust
use bevy::prelude::*;
use bevy_fleet::FleetEvent;

fn track_player_kill(mut events: MessageWriter<FleetEvent>) {
    events.write(
        FleetEvent::new("player.kill")
            .with_data("weapon", "rocket_launcher")
            .with_data("map", "de_dust2"),
    );
}
```


## telemetry payload (json)

```json
{
  "app_id": "example",
  "timestamp": 1760840585,
  "session_id": "session-68f44a99-ce4-27c87004",
  "session_stats": {
    "payloads_published": 12,
    "metrics_collected": 72,
    "diagnostics_recorded": 120
  },
  "machine_info": { "os": "Windows", "cpu_count": 16, "total_memory_bytes": 102757092557 },
  "metrics": [{ "name": "fps.value", "value": 60.10 }],
  "diagnostics": [{ "name": "frame_time.smoothed", "value": "16.63" }],
  "events": [],
  "panics": []
}
```

- metrics carry numeric values (ideal for dashboards)
- diagnostics keep smoothed + history metadata (no duplication)
- events + panics stream through tracing-friendly collectors


## examples

- `basic` – minimal setup, custom metric
- `advanced` – event tracking + custom diagnostics
- `test_server` – local telemetry viewer (`cargo run -p bevy_fleet_test_server --bin test_server`)

```bash
# start companion server
cargo run -p bevy_fleet_test_server --bin test_server

# in another terminal
cargo run --example basic
```


## bevy support

| `bevy_fleet` | `bevy` |
| :--          | :--    |
| `0.1`        | `0.17` |


## license

licensed under either of

- Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (http://opensource.org/licenses/MIT)

at your option.


## contribution

unless you say otherwise, any contribution submitted for inclusion in the project is dual-licensed as above.