소스 검색

stackdriver: add help section for annotations

Daniel Lee 7 년 전
부모
커밋
296fd35d47

+ 22 - 1
public/app/plugins/datasource/stackdriver/partials/annotations.editor.html

@@ -1,7 +1,7 @@
 <stackdriver-filter target="ctrl.annotation.target" refresh="ctrl.refresh()" datasource="ctrl.datasource"
   default-dropdown-value="ctrl.defaultDropdownValue" default-service-value="ctrl.defaultServiceValue" hide-group-bys="true"></stackdriver-filter>
 
-<div class="gf-form-inline">
+<div class="gf-form gf-form-inline">
   <div class="gf-form">
     <span class="gf-form-label query-keyword width-9">Title</span>
     <input type="text" class="gf-form-input width-20" ng-model="ctrl.annotation.target.title" />
@@ -14,3 +14,24 @@
     <div class="gf-form-label gf-form-label--grow"></div>
   </div>
 </div>
+
+<div class="gf-form grafana-info-box" style="padding: 0">
+  <pre class="gf-form-pre alert alert-info" style="margin-right: 0"><h5>Annotation Query Format</h5>
+An annotation is an event that is overlaid on top of graphs. Annotation rendering is expensive so it is important to limit the number of rows returned.
+
+The Title and Text fields support templating and can use data returned from the query. For example, the Title field could have the following text:
+
+<code ng-non-bindable>{{metric.type}} has value: {{metric.value}}</code>
+
+Example Result: <code ng-non-bindable>monitoring.googleapis.com/uptime_check/http_status has this value: 502</code>
+
+<label>Patterns:</label>
+<code ng-non-bindable>{{metric.value}}</code> = value of the metric/point
+<code ng-non-bindable>{{metric.type}}</code> = metric type e.g. compute.googleapis.com/instance/cpu/usage_time
+<code ng-non-bindable>{{metric.name}}</code> = name part of metric e.g. instance/cpu/usage_time
+<code ng-non-bindable>{{metric.service}}</code> = service part of metric e.g. compute
+
+<code ng-non-bindable>{{metric.label.label_name}}</code> = Metric label metadata e.g. metric.label.instance_name
+<code ng-non-bindable>{{resource.label.label_name}}</code> = Resource label metadata e.g. resource.label.zone
+</pre>
+</div>

+ 12 - 12
public/app/plugins/datasource/stackdriver/partials/query.editor.html

@@ -40,21 +40,21 @@
   <div class="gf-form" ng-show="ctrl.showLastQuery">
     <pre class="gf-form-pre">{{ctrl.lastQueryMeta.rawQueryString}}</pre>
   </div>
-  <div class="gf-form" ng-show="ctrl.showHelp">
-    <pre class="gf-form-pre alert alert-info"><h6>Alias Patterns</h6>
-  Format the legend keys any way you want by using alias patterns.
+  <div class="gf-form grafana-info-box" style="padding: 0" ng-show="ctrl.showHelp">
+<pre class="gf-form-pre alert alert-info"  style="margin-right: 0"><h5>Alias Patterns</h5>Format the legend keys any way you want by using alias patterns.
 
-  Example: <code ng-non-bindable>{{metric.name}} - {{metric.label.instance_name}}</code>
-  Result: cpu/usage_time - server1-europe-west-1
+<label>Example: </label><code ng-non-bindable>{{metric.name}} - {{metric.label.instance_name}}</code>
 
-  Patterns:
-  <code ng-non-bindable>{{metric.type}}</code> = metric type e.g. compute.googleapis.com/instance/cpu/usage_time
-  <code ng-non-bindable>{{metric.name}}</code> = name part of metric e.g. instance/cpu/usage_time
-  <code ng-non-bindable>{{metric.service}}</code> = service part of metric e.g. compute
+<label>Result: </label><code ng-non-bindable>cpu/usage_time - server1-europe-west-1</code>
 
-  <code ng-non-bindable>{{metric.label.label_name}}</code> = Metric label metadata e.g. metric.label.instance_name
-  <code ng-non-bindable>{{resource.label.label_name}}</code> = Resource label metadata e.g. resource.label.zone
-    </pre>
+<label>Patterns:</label>
+<code ng-non-bindable>{{metric.type}}</code> = metric type e.g. compute.googleapis.com/instance/cpu/usage_time
+<code ng-non-bindable>{{metric.name}}</code> = name part of metric e.g. instance/cpu/usage_time
+<code ng-non-bindable>{{metric.service}}</code> = service part of metric e.g. compute
+
+<code ng-non-bindable>{{metric.label.label_name}}</code> = Metric label metadata e.g. metric.label.instance_name
+<code ng-non-bindable>{{resource.label.label_name}}</code> = Resource label metadata e.g. resource.label.zone
+</pre>
   </div>
   <div class="gf-form" ng-show="ctrl.lastQueryError">
     <pre class="gf-form-pre alert alert-error">{{ctrl.lastQueryError}}</pre>

+ 9 - 0
public/sass/components/_infobox.scss

@@ -19,6 +19,15 @@
     padding-left: $spacer * 1.5;
   }
 
+  code {
+    @include font-family-monospace();
+    font-size: $font-size-base - 2;
+    background-color: $code-tag-bg;
+    color: $text-color;
+    border: 1px solid $code-tag-border;
+    border-radius: 4px;
+  }
+
   a {
     @extend .external-link;
   }