IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added informatio & help blocks to graphite metric editor

Browse Source
This commit is contained in:
Torkel Ödegaard 2014-09-11 09:27:49 +02:00
parent 99009a11ed
commit a640d55297
3 changed files with 120 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
src/app/partials/graphite/editor.html
View File

@ -1,4 +1,4 @@
<div class="editor-row" style="margin-top: 10px;"> <div class="editor-row">
<div ng-repeat="target in panel.targets" <div ng-repeat="target in panel.targets"
class="grafana-target" class="grafana-target"
@ -30,13 +30,6 @@
ng-click="duplicate()"> ng-click="duplicate()">
Duplicate Duplicate
</a> </a>
</li>
<li role="menuitem">
<a tabindex="1"
ng-click="toggleMetricOptions()">
Toggle request options
</a>
</li>
</ul> </ul>
</li> </li>
<li> <li>
@ -80,24 +73,109 @@
</div> </div>
</div> </div>
<div class="grafana-target grafana-metric-options" ng-if="panel.metricOptionsEnabled"> </div>
<section class="grafana-metric-options">
<div class="grafana-target-inner"> <div class="grafana-target-inner">
<ul class="grafana-segment-list"> <ul class="grafana-segment-list">
<li class="grafana-target-segment grafana-target-segment-icon">
<i class="icon-wrench"></i>
</li>
<li class="grafana-target-segment"> <li class="grafana-target-segment">
cacheTimeout <tip>Graphite parameter to overwride memcache default timeout (unit is seconds)</tip> cacheTimeout
</li> </li>
<li> <li>
<input type="text" <input type="text"
class="input-large grafana-target-segment-input" class="input-mini grafana-target-segment-input"
ng-model="panel.cacheTimeout" ng-model="panel.cacheTimeout"
spellcheck='false' bs-tooltip="'Graphite parameter to overwride memcache default timeout (unit is seconds)'"
placeholder="60"> data-placement="right"
spellcheck='false'
placeholder="60">
</li> </li>
</ul> </ul>
<div class="clearfix"></div> <div class="clearfix"></div>
</div>
<div class="grafana-target-inner">
<ul class="grafana-segment-list">
<li class="grafana-target-segment grafana-target-segment-icon">
<i class="icon-info-sign"></i>
</li>
<li class="grafana-target-segment">
<a ng-click="toggleEditorHelp(1);" bs-tooltip="'click to show helpful info'" data-placement="bottom">
shorter legend names
</a>
</li>
<li class="grafana-target-segment">
<a ng-click="toggleEditorHelp(2);" bs-tooltip="'click to show helpful info'" data-placement="bottom">
series as paramaters
</a>
</li>
<li class="grafana-target-segment">
<a ng-click="toggleEditorHelp(3)" bs-tooltip="'click to show helpful info'" data-placement="bottom">
stacking
</a>
</li>
<li class="grafana-target-segment">
<a ng-click="toggleEditorHelp(4)" bs-tooltip="'click to show helpful info'" data-placement="bottom">
templating
</a>
</li>
</ul>
<div class="clearfix"></div>
</div> </div>
</div> </div>
</section>
<div class="editor-row">
<div class="pull-left" style="margin-top: 30px;">
<div class="grafana-info-box span8" ng-if="editorHelpIndex === 1">
<h5>Shorter legend names</h5>
<ul>
<li>alias() function to specify a custom series name</li>
<li>aliasByNode(2) to alias by a specific part of your metric path</li>
<li>aliasByNode(2, -1) you can add multiple segment paths, and use negative index</li>
<li>groupByNode(2, 'sum') is useful if you have 2 wildcards in your metric path and want to sumSeries and group by</li>
</ul>
</div>
<div class="grafana-info-box span8" ng-if="editorHelpIndex === 2">
<h5>Series as parameter</h5>
<ul>
<li>Some graphite functions allow you to have many series arguments</li>
<li>Use #[A-Z] to use a graphite query as parameter to a function</li>
<li>
Examples:
<ul>
<li>asPercent(#A, #B)</li>
<li>prod.srv-01.counters.count - asPercent(#A) : percentage of count in comparison with A query</li>
<li>prod.srv-01.counters.count - sumSeries(#A) : sum count and series A </li>
<li>divideSeries(#A, #B)</li>
</ul>
</li>
<li>If a query is added only to be used as a parameter, hide it from the graph with the eye icon</li>
</ul>
</div>
<div class="grafana-info-box span6" ng-if="editorHelpIndex === 3">
<h5>Stacking</h5>
<ul>
<li>You find the stacking option under Display Styles tab</li>
<li>When stacking is enabled make sure null point mode is set to 'null as zero'</li>
</ul>
</div>
<div class="grafana-info-box span6" ng-if="editorHelpIndex === 4">
<h5>Templating</h5>
<ul>
<li>You can use a template variable in place of metric names</li>
<li>You can use a template variable in place of function parameters</li>
<li>You enable the templating feature in Dashboard settings / Feature toggles </li>
</ul>
</div>
</div>
</div> </div>

16
src/app/partials/influxdb/editor.html
View File

@ -181,8 +181,8 @@
<div class="grafana-target"> <div class="grafana-target">
<div class="grafana-target-inner"> <div class="grafana-target-inner">
<ul class="grafana-segment-list"> <ul class="grafana-segment-list">
<li class="grafana-target-segment"> <li class="grafana-target-segment grafana-target-segment-icon">
<i class="icon-cogs"></i> <i class="icon-wrench"></i>
</li> </li>
<li class="grafana-target-segment"> <li class="grafana-target-segment">
group by time group by time
@ -227,8 +227,8 @@
<div class="editor-row"> <div class="editor-row">
<div class="pull-left" style="margin-top: 30px;"> <div class="pull-left" style="margin-top: 30px;">
<div class="span6" ng-if="editorHelpIndex === 1"> <div class="grafana-info-box span6" ng-if="editorHelpIndex === 1">
Alias patterns: <h5>Alias patterns</h5>
<ul> <ul>
<li>$s = series name</li> <li>$s = series name</li>
<li>$g = group by</li> <li>$g = group by</li>
@ -236,8 +236,8 @@
</ul> </ul>
</div> </div>
<div class="span6" ng-if="editorHelpIndex === 2"> <div class="grafana-info-box span6" ng-if="editorHelpIndex === 2">
Stacking and fill: <h5>Stacking and fill</h5>
<ul> <ul>
<li>When stacking is enabled it important that points align</li> <li>When stacking is enabled it important that points align</li>
<li>If there are missing points for one series it can cause gaps or missing bars</li> <li>If there are missing points for one series it can cause gaps or missing bars</li>
@ -247,8 +247,8 @@
</ul> </ul>
</div> </div>
<div class="span6" ng-if="editorHelpIndex === 3"> <div class="grafana-info-box span6" ng-if="editorHelpIndex === 3">
Group by time: <h5>Group by time</h5>
<ul> <ul>
<li>Group by time is important, otherwise the query could return many thousands of datapoints that will slow down Grafana</li> <li>Group by time is important, otherwise the query could return many thousands of datapoints that will slow down Grafana</li>
<li>Leave the group by time field empty for each query and it will be calculated based on time range and pixel width of the graph</li> <li>Leave the group by time field empty for each query and it will be calculated based on time range and pixel width of the graph</li>

19
src/css/less/grafana.less
View File

@ -485,3 +485,22 @@ select.grafana-target-segment-input {
color: @variable; color: @variable;
} }
.grafana-info-box:before {
content: "\f05a";
font-family:'FontAwesome';
position: absolute;
top: -8px;
left: -8px;
font-size: 20px;
color: @blue;
}
.grafana-info-box {
position: relative;
padding: 5px 15px;
background-color: @grafanaTargetBackground;
border: 1px solid @grafanaTargetBorder;
h5 {
margin-top: 5px;
}
}