GUI
当前,OpenTSDB 提供了一个简单的内置 GUI,方法是打开浏览器并导航到运行 TSD 的主机和端口。例如,如果您正在本地计算机上的端口 4242 上运行 TSD,则只需导航至http://localhost:4242
即可。虽然 GUI 不会因美观而获奖,但它提供了一种快速的方法来使用系统中的数据构建有用的图形。
可以以开源Grafana的形式找到更好的 GUI。
Interface
GUI 的三个主要区域:
-
用作菜单的通知区域和标签区域
-
查询构建器,使您可以选择要显示的内容以及显示方式
-
显示查询结果的图形区域
Menu
菜单是一组选项卡,可以单击这些选项卡以获得不同的选项。
Errors
构建图形时,如果发生错误,则菜单上方将显示一条消息。单击箭头以展开该消息并确定错误是什么。
Query Builder
您可能会在此领域花费大量时间,因为有很多选择可以使用。您可能首先要选择一个或多个要绘制图形的 Metrics 和标签。
Note
如果您从选择开始时间和结束时间开始,那么一旦 ImportingMetrics,TSD 就会开始绘制该 Metrics 的每个时间序列。这将显示Loading Graph...
状态,并且可能需要很长时间才能执行其他任何操作。因此,跳过时间并首先选择 Metrics。
Note
另请注意,对本节中的任何字段进行更改都会导致图形重新加载,因此请注意,如果图形加载时间较长。
Metrics Section
在此区域中,您可以为图表选择 Metrics,可选标签,聚合函数以及可能的向下采样器。顶部是一对蓝色的标签。每个图可以显示多个 Metrics,并且选项卡组织不同的子查询。每个图都需要至少一个 Metrics,因此您将在第一个标签中选择该 Metrics。要将其他 Metrics 添加到图形中,请点击“ +
”标签,然后即可设置另一个子查询。如果配置了多个 Metrics,只需单击与要修改的 Metrics 相对应的选项卡。该选项卡将显示与其关联的度量标准名称的子集。
在“Metrics”框中,您可以选择一个 Metrics。就像现代 Web 浏览器一样,该字段会在您键入时自动完成。自动完成通常区分大小写,因此只会显示与提供的大小写匹配的 Metrics。默认情况下,仅返回前 25 个匹配项,因此您键入时可能看不到所有可能的选择。单击显示时所需的条目,或 continue 键入直到框中有整个 Metrics。
从查询或读取数据文档中回想起,如果您仅提供一个不带任何标签的 Metrics,那么带有该 Metrics 的每个时间序列都会汇总到结果中。如果要向下钻取,请提供一个或多个“标签”以过滤或分组结果。新的 Metrics 部分将在 Tags 旁边有两个框。左侧的框用于标记名称或tagk
值,例如host
或symbol
。右侧框用于标记值或tagv
,例如webserver01
或google
。添加标签时,将出现另一对框,以便您可以 continue 添加标签以进行必要的过滤。
标签名称和值框也都以与“度量标准”框相同的方式自动完成。但是,每个自动完成操作都会显示名称或值的所有结果,而不仅是适用于特定 Metrics 或标签名称的值。在将来的版本中,我们可能可以实现这种 Map 功能,但是当前您必须对所有值进行排序。
在 2.2 版中,每对复选框右边的复选框用于确定结果应按标记过滤器分组(选中)还是汇总(未选中)。默认情况下,已选中该框以显示 2.2 之前的 TSD 行为。
标签值框可以使用分组运算符,例如*
和|
。有关详情,请参见查询或读取数据。标记值框也可以使用 2.2 版以上的过滤器。例如。您可以 Importing“通配符(webserver *)”作为标记值,它将匹配所有以“ webserver”开头的主机。
在“比率”框中,您可以将度量标准的所有时间序列转换为变化率值。默认情况下,此选项处于关闭状态。
Rate ctr 启用下面的“ Rate”选项框,并指示所绘制的 Metrics 是单调递增的计数器。如果是这样,您可以选择为计数器提供一个最大值( Rate Ctr Max ),这样当它翻转时,图形将显示正确的值而不是负数。同样,如果速率大于该值,则可以选择设置一个重置值( Rate Ctr Reset )以将值替换为零。为避免出现负尖峰,通常省去将速率计数器设置为重置值 1 的麻烦。
对于具有不同比例的度量标准或时间序列,您可以选中“右轴”复选框,以在度量标准的时间序列的图形右侧添加另一个轴。如果比例尺相差很大,则可以使图形更具可读性。
“聚合器”框是聚合函数的下拉列表,用于处理与子查询关联的多个时间序列的数据。默认的聚合器是* sum *,但是您可以从许多其他选项中进行选择。
“下采样”部分用于减少图形上显示的数据点数量。默认情况下,GnuPlot 将在图形的每个数据点放置一个字符,例如+
或x
。当时间 Span 较宽且有许多数据点时,该图可能会变得很粗且很丑。使用下采样以减少点数。只需从下拉列表中选择一个聚合函数,然后在第二个框中 Importing 一个时间间隔。时间间隔必须遵循相对日期格式(不含-ago
组件)。例如,要在一小时内进行降采样,请 Importing1h
。当与其他系列汇总时,最后一个选择框为下采样值选择“填充策略”。对于在 GUI 中作图,只有“零”值有所不同,因为它将用零代替缺失的序列。有关详情,请参见日期和时间。
Downsampling Disabled
Downsampling Enabled
Time Section
时间分段确定图形中所有 Metrics 和时间序列的时间 Span。 “开始时间”决定了图表的开始时间,“结束时间”决定了图表的停止时间。必须填写这两个字段才能执行查询。时间可以采用人类可读的绝对格式或相对格式。有关详情,请参见日期和时间。
单击一个时间框将弹出一个 Util,以帮助您选择时间。使用框左上方的箭头浏览月份,然后单击日期。右上角的相对链接是帮助者向前或向后跳转 1 分钟,10 分钟,1 小时,1 天,1 周或 30 天。 * now 链接会将时间更新为本地系统上的当前时间。 HH 按钮可让您选择一个小时以及 AM 或 PM *。 MM 按钮使您可以选择标准化的分钟。您也可以将时间剪切并粘贴到任何框中,或直接编辑时间。
Note
框中不直接支持 Unix 时间戳。您可以单击一个框以显示 calendar,然后在* UNIX Timestamp 框中粘贴 Unix 时间戳(以秒为单位),然后按 TAB *键将其转换为人类可读的时间戳。
如果时间框中的时间戳无效,则背景将变为红色。如果您的开始时间大于或等于结束时间,则可能会发生这种情况。
“到(现在)”链接会将“结束”框更新为系统上的当前时间。
单击“自动重装”复选框以定期自动刷新图形。这对于监视要在其中显示多个人的图形的显示非常有用。选中后,“结束”框将消失,由“每个:**”框代替,您可以在几秒钟内选择刷新率。默认值为每 15 秒刷新一次。
Graphing
我们将在这里快速绕道,以讨论实际的图形部分。在查询构建区域的下方是显示有关查询结果的详细信息以及实际图形的位置。
状态行会打印有关查询结果的信息,包括是否将结果缓存在 TSD 中,分析了多少原始数据点,实际绘制了多少数据点(根据聚合和下采样的结果)以及查询执行所需的时间。当浏览器 await 查询结果时,此消息将显示Loading Graph...
。
Note
使用内置 UI 时,图形在磁盘上缓存 60 秒。如果启用了自动刷新并且使用默认值 15s,则将显示缓存的图形,直到 60 秒过去。如果您有更高分辨率的数据要进入,并且想绕过缓存,只需将&nocache
附加到 GUI URL。
状态线下方将是实际图形。该图形只是 GnuPlot 生成的 PNG 图像,因此您可以复制该图像并将其保存到本地计算机或通过电子邮件发送。
您还可以通过在图形的某个部分上单击并拖动红色框来放大时间范围。发布并使用新的时间范围更新查询。请注意,当您将鼠标悬停在图形上方时,浏览器光标不会发生变化,它仍将是浏览器或 os 提供的默认箭头。
Graph Style
返回查询构建器部分的右侧是图形样式框。
“ WxH **”框会更改图形的尺寸。只需以像素为单位 Importing<width>x<height>
(例如1024x768
),然后按 Tab 或单击另一个框即可更新图形。
在 2.3 中,提供了*“全局 Comments”复选框,用于查询并包括应应用于所有时间序列的 Comments。
在其下面是几个选项卡,用于更改图形的不同部分。
Axes Tab
该区域用于更改图形的 Y 轴。 Y 设置会影响左侧的轴,而 Y2 设置会影响右侧的轴。仅当至少一项度量标准的“右轴”复选框处于选中状态时,才启用 Y2 设置。
“标签”框会将指定的文本添加到图形的左侧或右侧的 Y 轴上。默认情况下,由于 OpenTSDB 不知道您在绘制什么图形,因此不提供标签。
“格式”框可以根据自定义算法或格式更改 Y 轴上的数字。如果数据以字节为单位进来,这对于将数字转换为科学计数法或从科学计数法转换数字并调整小数位的大小很有用。例如,您可以提供%0.0f Reqs
的值,它将改变轴以在每一步显示一个整数值,并在其后加上字符串* Reqs *,如以下示例所示。
阅读GnuPlot Manual,了解格式说明符,以了解允许的内容。
“范围”框使您可以有效地水平缩放,仅显示 Y 轴值范围之间的数据点。此框的格式为[<starting value>:<optional end value>]
。例如,如果我只想显示值在 700 到 800 之间的数据点,则可以 Importing[700:800]
。这将产生如下图:
“对数刻度”复选框将在 Y 轴上设置以 10 为底的对数刻度。下面显示一个示例。
Key Tab
键选项卡部分的上半部分处理图形键的位置。这是一系列的按钮,旨在向您显示密钥的显示位置。一个框围绕一些按钮,指示该键将出现在图形的框内,并覆盖数据。默认位置在图形框的右上方。只需选择一个按钮即可移动钥匙箱。
默认情况下,该键垂直列出所有不同的标签。 “水平布局”复选框将首先水平放置关键点,然后在图形的尺寸不支持时垂直放置关键点。
Box 复选框将在按键周围切换一个框轮廓。默认情况下处于启用状态。
“无键”复选框将完全隐藏该键。
Style Tab
样式标签目前只有一个框,即“平滑”复选框。选中此选项,将从图上删除数据点字符(仅显示线条),并使用样条线对数据进行平滑处理(至少需要绘制三个点)。与默认设置相比,某些用户更喜欢此设置。
保存您的工作
通过 GUI 进行更改时,您会看到该 URL 反映了您的编辑。您可以复制 URL,将其保存或通过电子邮件发送,然后将其拉回以选择您所在的位置。不幸的是,OpenTSDB 没有内置的仪表板,因此您必须手动将 URL 保存在某个地方。