#task #applications #console #data #async #format #resources

hds_console-api

这是一个测试软件包,请勿使用

2 个不稳定版本

0.7.0 2024 年 4 月 12 日
0.6.1 2024 年 4 月 9 日

#862 in 异步


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 文档

概述

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

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

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

此软件包中的线路格式 protobuf 绑定由 console-subscriber 软件包中的仪表板使用,该仪表板以该格式发出遥测数据,并由使用该遥测数据的客户端使用。

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

稳定性

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

crate特性标志

此crate提供了以下特性标志

寻求帮助

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

贡献

🎈 感谢您为改进项目提供帮助!我们非常高兴有您!我们有一个贡献指南,以帮助您参与Tokio控制台项目。

支持的Rust版本

Tokio控制台是基于最新稳定版本构建的。最低支持的版本是1.64。当前Tokio控制台版本不能保证在低于最低支持版本的Rust版本上构建。

许可

本项目采用MIT许可

贡献

除非您明确声明,否则您有意提交以包含在Tokio中的任何贡献,都应按照MIT许可,不附加任何额外条款或条件。

依赖

~9–19MB
~249K SLoC