跳转到主要内容

应用程序,用于改进Nautobot的监控并公开额外的指标(应用程序指标、RQ Worker)。

项目描述

指标与监控扩展应用程序



Nautobot提供的应用程序

指标端点

Nautobot已经通过Prometheus端点公开了一些信息,但当前可用的信息大多在系统级别,而不是在应用级别。系统指标和应用级别指标是互补的。

  • 系统指标对于监控代码、跟踪短暂信息并更好地了解所发生的事情非常有用。(指标示例:请求数量、每秒请求数量、异常数量、响应时间等)想法是当多个Nautobot实例在负载均衡器后面运行时,每个实例都会生成一组不同的指标,监控系统需要从所有运行的实例中收集这些指标并将它们聚合到仪表板中。Nautobot在localhost/metrics处公开了一些系统指标 - 更多信息请参阅Nautobot 文档
  • 应用指标位于更高层面,代表在负载均衡器背后所有应用实例相同的信息。如果我有3个Nautobot实例正在运行,就没有必要询问每个实例数据库中有多少设备对象,因为它们总是会返回相同的信息。在这种情况下,目标是只公开一个任何运行实例都可以提供的端点。Prometheus端点位于/api/plugins/capacity-metrics/app-metrics

目前应用默认公开以下简单指标

  • 作业统计
  • 模型数量(可通过nautobot_config.py配置)

此外,可以使用应用配置来公开关于Python、Django、Nautobot版本以及已安装的Nautobot应用的应用的指标。

试试看吧!

此应用已安装在Nautobot社区沙箱中,可在demo.nautobot.com找到!

要查看所有始终开启的沙箱环境列表,请访问networktocode.com的主页。

文档

此应用的完整文档可在Nautobot Docs网站上找到

为文档做贡献

您可以在本存储库中的docs文件夹下找到应用文档的所有Markdown源文件。[docs](https://github.com/nautobot/nautobot-app-capacity-metrics/tree/develop/docs)。对于简单的编辑,Markdown兼容的编辑器就足够了:克隆存储库并开始编辑。

如果您需要查看完全生成的文档网站,可以使用MkDocs构建它。可以使用存储库中的invoke命令启动托管文档的容器(详细信息请参阅开发环境指南),在https://127.0.0.1:8001。使用此容器,当您保存对文档的更改时,它们将自动重建,并且当前正在查看的任何页面将在您的浏览器中重新加载。

非常欢迎任何包含修复或改进的PR!

问题

对于任何问题或评论,请先查看常见问题解答。您也可以随时访问Network to Code Slack(频道#nautobot),如果您没有账户,请在此处注册

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

nautobot_capacity_metrics-3.1.1.tar.gz (1.2 MB 查看哈希值

上传时间

构建分发

nautobot_capacity_metrics-3.1.1-py3-none-any.whl (1.3 MB 查看哈希值

上传时间 Python 3