#async #tracing #tonic #tokio-console

console-api

Tokio控制台的Protobuf线格式绑定

10个版本 (重大更新)

0.8.0 2024年7月29日
0.6.0 2023年9月29日
0.5.0 2023年5月9日
0.4.0 2022年8月10日
0.1.0 2021年12月16日

#391 in 调试

Download history 80020/week @ 2024-04-26 78635/week @ 2024-05-03 84028/week @ 2024-05-10 97781/week @ 2024-05-17 98772/week @ 2024-05-24 97968/week @ 2024-05-31 95981/week @ 2024-06-07 96601/week @ 2024-06-14 94566/week @ 2024-06-21 84151/week @ 2024-06-28 86252/week @ 2024-07-05 84338/week @ 2024-07-12 86263/week @ 2024-07-19 83985/week @ 2024-07-26 78378/week @ 2024-08-02 73091/week @ 2024-08-09

336,355 每月下载量
用于 84 个crate (直接使用2个)

MIT 许可证

95KB
1.5K SLoC

tokio-console API

🛰 Tonic 绑定 tokio-consoleprotobuf 线格式。

crates.io Documentation Documentation (main branch) MIT licensed Build Status Discord chat

网站 | 聊天 | API文档

概述

该crate包含用于 tokio-console 线格式的生成 protobuf 绑定。线格式用于从已配置的应用程序导出诊断数据到聚合和显示这些数据的消费者。

tokio-console 是异步Rust应用程序的调试和性能分析工具,它收集并显示应用程序中异步任务、资源和操作的深入诊断数据。控制台系统由两个主要组件组成

  • instrumentation,嵌入应用程序中,从异步运行时收集数据并通过控制台的线格式暴露
  • 消费者,如 tokio-console 命令行应用程序,该应用程序连接到配置了的应用程序,接收遥测数据并将结果显示给用户

该crate中的线格式 protobuf 绑定由 console-subscriber crate中的instrumentation使用,该crate以这种格式发出遥测,并且由消费遥测数据的客户端使用。

通常情况下,大多数 tokio-console 用户不会直接依赖这个crate。应用程序通常使用 console-subscriber crate进行配置,该crate收集数据并使用这种线格式导出;这些数据可以通过 tokio-console 命令行应用程序进行消费。然而,这个crate中关于线格式API的定义可能对任何实现也消费 tokio-console 诊断数据的其他软件的人来说是有用的。

稳定性

⚠️ 目前不认为protobuf线格式是完全稳定的。虽然我们将尽量避免不必要的protobuf不兼容的更改,但protobuf兼容性仅保证在此crate的SemVer兼容版本内。例如,版本为 console-api v0.2.5的protobuf可能与 console-api v0.1.12不向后兼容。

crate功能标志

此crate提供以下功能标志

获取帮助

首先,查看您的问题是否可以在API文档中找到答案。如果答案不在那里,Tokio Discord服务器中有一个活跃的社区。我们很乐意尝试回答您的问题。您也可以在讨论页面上提问。

贡献

🎈 感谢您帮助我们改进项目!我们非常高兴能邀请您加入!我们有一个贡献指南,帮助您参与Tokio控制台项目。

支持的Rust版本

托克伊控制台针对最新稳定版本构建。最低支持的版本是1.64。当前托克伊控制台版本不保证在低于最低支持版本的Rust版本上构建。

许可证

本项目受MIT许可证许可。

贡献

除非您明确声明,否则您提交给Tokio的任何有意贡献的内容都将按MIT许可证授权,不附加任何额外条款或条件。

依赖项

~5–6.5MB
~114K SLoC