openTSDB详解之GUI

目前，openTSDB提供一个简单的内置GUI，你可以在浏览器导航栏中输入TSD正在运行的主机和端口号来访问。例如：如果你在本地计算机运行一个TSD，其运行端口是4242，那么（浏览器中）访问地址就是：http://localhost:4242。然而GUI不会赢得美丽的盛誉（译者注：openTSDB的GUI真心很丑），它只是提供一个快速的方式使用你系统中的数据去构建一个有用的图像。
一个更好看的GUI能够以开源产品的形式呈现——Grafana。

Interface

GUI主要有三个区域：

• 提示栏以及作为菜单栏的tab选项卡。
• 查询构建器—允许你选择什么样的数据被展示，以及如何展示
• 展示查询结果的图像的区域

Menu

菜单是一组tab选项卡，为了不同的目的可以点击不同的选项卡。

• Graph:这是一个默认呈现的，并且让你发起查询以及产生一个图像的菜单
• Stats:这个tab将会展示一系列关于运行tsd的统计数据。相同的统计值也可以通过/stats或者是/api/stats端获取
• Logs：如果Logback是已经配置了的，这个tab将会展示你运行TSD的最近的1024条日志
• Version：展示关于你的TSD的版本信息

Errors

当构建一个图像时，如果有任何的错误发生，会在菜单栏之上出现一条消息。点击箭头【错误提醒所在的最左端】并且可以查看并确定错误是什么。

Query Builder

你很有可能将在这个上面花费一些时间，因为这个区域有许多选项可以使用。你很有可能想开始选择一或多个metrics、tags去画图。

Note

如果你一开始就选择一个开始，结束时间，一旦你输入一个metric，那么TSD将会开始画图—针对于某metric的每个时间序列。这将显示出Loading Graph···的状态，并且在你能够做其它事之前需要花费一点时间。所以应该先跳过时间区域，首先选择metrics部分。

Note

同样需要注意的是，改变这个区域内的任何字段，都会造成数据的重新加载，所以如果你的数据是需要很长时间才加载出来的话，请你务必小心。

Metric Section

这个区域是你选择metrics，tags，聚合函数以及一个可能的缩小样本的方法（即down sampler）的地方。在顶部，是一对蓝色tab键。每个图像能够展示多个metrics并且tabs 组织不同的子查询。每个图像要求至少一个metric，所以你将选择第一个tab中的metric。为了将另外的metric添加到你的图像中，点击+键，然后你将能够开启另外一个子查询。如果你已经配置了多个metrics，仅仅点击metric所在的tab。tab将会展示出与它相联系的metric name的子集。
metric选择框是你选择一个metric的地方。就像是一个现代网络浏览器，这个字段在你输入的时候具有自动补全功能。通常情况，自动补全是区分大小写的，所以仅仅匹配的metric才会被展示出来。默认时，仅仅将最匹配的前25个条目返回，所以你可能不需要将全部的选择作为你的输入。要么当它出现时点击你想的条目，或者保持输入，直到输入框中有整个metric。

从之前的文章“Querying or Reading Data”回忆，如果你仅仅提供一个metric，却没有任何的tags，每个拥有该metric的时间序列将会被聚合到结果中。如果你想更深入挖掘，应用一个或多个tags去过滤、分组结果集。一个新的metric部分将有两个输入框，与tags相邻。左边的输入框是tag name或者是tagk 的值，例如host或者symbol。右边的输入框是为tag value或者tagn，例如：webserver01或者google。当你添加一个tag，另一个框将会出现，所以如果需要，你能够保持添加tags去过滤数据。
类似metric输入框，tag name 、tag value输入框都是自动补全的。然而，每个自动补全将会展示所有的结果，对于tag name /value，而不仅仅是values，应用到指定的metric或者是tag name。在将来的版本中，我们可能能够实现此类的映射特征，但是当前，你将不得不重新检索所有值。
在版本2.2中，每对选择框右侧的checkbox是被用于决定结果是否会根据这些tag filter(checked时的情况)还是aggregated(unchecked)分组。在版本2.2之前，选择框默认是被勾选的用于展示TSD的行为。(原文：The boxes are checked by default to exhibit the behavior of TSD prior to 2.2.)
tag value框能够使用分组操作符，诸如：*以及|。查看“Querying or Reading Data”。tag value 能够使用过滤器，在版本2.2中。例如，你能够输入“wildcard(webserver*)”作为一个tag value并且它将匹配所有以“webserver”打头的主机。
Rate 框允许你将所有的时间序列的metric转换成一个变换速率。默认情况下，这个选项是关闭的。
Rate ctr 控件让rate 选项框…，并表明画出的metric图像是一个单增的计数器。（原文：Rate ctr Enables the rate options boxes below and indicate that the metric graphed is a monotonically increasing counter.）如果是这样的话，你能选择去应用一个最大值（Rate Ctr Max）为了计数器所以当它翻转过来的时候，图像将会显示出合适的值而不是一个负数。同样，你能够选择设置一个重置值（Rate Ctr Reset）0，如果rate比值大的话。为了避免负数的峰值，它通常保存为了去设置rate counter 当一个reset 为 1 的时候（原文：To avoid negative spikes it's generally save to set the rate counter with a reset value of 1）。

对于metrics或者是时间序列，具有不同规模，你能够选择Right Axis选项框去添加另外的轴线到图像的右侧，针对metric的时间序列。这能够让图像更加可读，如果尺度差距很大。
Aggregator 选择框是一个下拉列表，关于aggregation 函数，用于计算数据对于多个时间序列联系的子查询。默认的aggregator是sum，但是你能够选择任意其中一个。
Downsample部分被用于减少数据点数量，展示在图中。默认情况下，GNuplot将会放置一个字符，诸如+或者x在每个图像的数据点。当时间序列范围很广并且有许多数据点的时候，图像将会变得十分的厚重和丑陋。使用down sampling去减少点数。简单的选择一个聚合函数从下拉列表中，然后数据一个时间间距在第二个选择框中。间距必须按照相对日期格式（没有-ago组件）。例如，为了downsampl到1小时，输入1h。最后一个选择框选择一个“fill policy”为downsampled值，当聚合没有其他序列时。为了使用GUI画图，仅仅0值
稍有不同因为它将以0替代丢失的值。（原文For graphing in the GUI, only the "zero" value makes a difference as it will substitute a zero for missing series）详见Dates and Times。

• Downsampling Disabled
  
• Downsampling Enabled
• 

Time Section

时间区域决定了对于整个metrics以及时间序列的时间跨度，在你的图像中。Frome时间决定了你图像的开始时间，并且End时间决定了图像的结束时间。为了执行一个查询，所有的字段区域必须被填写。时间可能以人类可读方式出现，绝对的格式或者是相对的格式，详见Dates and Times。
勾选一个时间框将会弹出一个实用工具，从而帮助你选择时间。实用可选框的左边顶部的箭头会遍历月份，然后选择一个日期。相对的链接在右上边能够帮助我们向前或者向后滚动1min，10min，1h，1day，1week或者是30天。now()这个链接将更新时间到目前时间，在你的本地系统中。HH按钮让你选择一个时间以AM或者PM。MM按钮让你选择一个规范化的分钟，你能够剪切并且粘贴一个时间到任何选择框中或者直接编辑选择框。

Note

Unix 时间戳是不直接支持在选择框中。 你能够点击选择框去展示一个日历，然后在UNIX Timestamp框中粘贴一个Unix时间戳（秒级别），然后输入tab 键去转换成人类可读的时间。
如果时间戳在一个时间选择框中的是无效的，时间选择框的背景将会变红。这会发生在如果开始时间是大于等于结束时间的时候。
To(now)这个链接将会更新结束时间成当前时间。
Autoreload选项框会触发周期地自动刷新。对于你想为许多人用图像展示的监控来说，这是非常有用的。当勾选之后，End 选项框将会被一个Every选项框替代：这个选项框让你选择一个更新频率。默认的更新频率是15秒一次。

Graphing

我们将在这里简单而快速的介绍一下实际的图像部分（原文：We'll make a quick detour here to talk about the actual graph section）。在查询构建区域下的一个区域：查询结果将被展示，同时也有实际的图像。

一条状态线打印关于查询结果的信息，包括：查询的结果集是否是缓冲在TSD中？（本次查询时有）多少raw data 被分析，多少数据点被画出来（在聚合函数和downsampling的前提下）？并且查询花费了多少时间去执行。在查询结果在浏览器中被展示之前，这个消息将会展示”Loading Graph...”

Note

当使用内置UI时，图像每60s就被缓存在硬盘中。如果自动刷新是开启的，并且默认的15s是被使用的，缓存的图像将会被展示直到60s过去。如果你有较高的频率进入并且想绕过缓存，仅仅追加&nocache到GUI的URL即可。
在状态线下面将会有实际的图像。图像仅仅是一个由Gnuplot产生.png图像，所以你能够copy图像并且保存在你的本地中，或是使用邮件发送。
通过点击并且拖放图像的一部分（这个步骤可以形成一个红色框【译者注：可能新的版本不是红色的】，如下图所示），你能够放大一个时间范围。释放鼠标之后，在选定的新的时间范围中，会触发执行更新查询。注意：浏览器光标不会改变，当你的鼠标在图像上时，它将仍然保持你系统或者是浏览器默认的箭头状。

Graph Style

回到查询构建部分，你可以在右侧选择框画图风格。
WxH【译者注：这个其实就是Width*Height的缩写】选择框改变图像的大小。仅仅输入width*height像素大小，诸如1024*768，然后按tab键或者点击另外一个选择框去触发图像更新。
在版本2.3中，一个全局的Annotation选择框被提供用于执行查询以及包括应该应用于所有时间序列中的注释。
在该tab下面，是一些用于改变图像的部分键，（下面会逐一介绍）。

Axes Tab

这个区域处理的是改变图像的y轴。Y的设置影响到左边的轴线，Y2的设置会影响到右边的轴线。Y2设置开启的前提是：至少有一个metrics，且Right Axis选择框勾选。【译者注：如下图1,2部分】

Label 选择框将会添加指定的标签到图像中的左边或者右边的轴线中。默认情况下，没有标签被提供，因为openTSDB不知道你画的图像是什么。
Format 选择框能够根据一个自定义算法或者格式修改Y轴上的数字 （原文：The Format box can alter the numbers on the Y axis according to a custom algorithm or formatting）。如果数据以字节的形式出现，那么数字和科学计数法之间的转换，并调整千兆字节的规模是很有用的（原文：This can be useful to convert numbers to or from scientific notation and adjusting the scale for gigabytes if the data comes in as bytes）。例如：你能够应用一个值：%0.0f Reqs并且它将改变每个阶段的轴线去展现一个整数值，在其后使用字符串Reqs，下面就是一个例子（原文：For example, you can supply a value of %0.0f Reqs and it will change the axis to show an integer value at each step with the string Reqs after it as in the following example.）：【译者注：观察下面的图形，可以看到左侧Y轴的标注信息后都有Reqs作为结尾】

为了Format Specifiers，可以阅读GnuPlot Manual，去寻找什么是被允许使用的。
Range 选择框允许你有效的水平放大，仅仅展现在y轴值范围间的数据点。这个选择框的格式是：[<starting value>:<optional and value>]。例如：如果想展示仅仅数据点在700—800之间的，我能够输入[700:800]。这将产生如下的图像：

Log Scale 的复选框将在Y轴上设置一个底为10的对数刻度。出现下面的一个例子。

Key Tab

key选项的上半部分处理图像的键位置。这是一系列按钮，去展示key box将会显示在哪里【如下图所示】。

一个选择框由一些按钮包围，指示这些显示在图像框中的按钮将会遮盖实际的图形数据。默认的位置是图像框的右上角。仅仅选择一个按钮将key box移出图形之外。

默认情况下，key 选项垂直列出所有的不同的标签。如果图像的维度不支持，Horizontal Layout选择框将会首先展示key horizontally，然后垂直展示。
Box选择框将会键周围包裹一个方框轮廓，这是默认勾选的。
No Key 选择框将会把键完全隐藏起来。

Style Tab

style 选项卡目前仅有单个选择框—Smooth 选择框。如果这个被选择，数据点字符将会从图像中移除（仅仅展示线）并且数据将会splines平滑的（至少需要画出三个点）。一些用户更喜欢使用默认值。

【译者注：截止译稿完成时，版本2.3.0界面已经有两个选项框了，如下图所示】

Saving Your Work

因为你通过GUI做出了改变，你将看到URL的变化反应了你的编辑。你能够复制URL，保存它或者将其发送，以及备份。不幸的是，openTSDB不能包括一个内置的仪表盘，所以你必须手动存储URL。