operations-opsconsole-charts.xml

<?xml version="1.0"?>
<!DOCTYPE section [
 <!ENTITY % entities SYSTEM "entities.ent"> %entities;
]>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
 xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="charts">
 <title>Visualizing Data in Charts</title>
 <para>
  &opscon; allows you to create a new chart and select the time range
  and the metric you want to chart, based on Monasca metrics.
 </para>
 <para>
  Present data in a pictorial or graphical format to enable administrators and
  decision makers to grasp difficult concepts or identify new patterns.
 </para>
 <para>
  <emphasis role="bold">Create new time-series graphs from
  <emphasis>My Dashboard</emphasis>.</emphasis>
 </para>
 <para>
  <emphasis>My Dashboard</emphasis> also allows you to customize the view in
  the following ways:
 </para>
 <itemizedlist>
  <listitem>
   <para>
    Include alarm cards from the Central Dashboard
   </para>
  </listitem>
  <listitem>
   <para>
    Customize graphs in new ways
   </para>
  </listitem>
  <listitem>
   <para>
    Reorder items using drag and drop
   </para>
  </listitem>
 </itemizedlist>
 <para>
  <emphasis role="bold">Plan for future storage</emphasis>
 </para>
 <itemizedlist>
  <listitem>
   <para>
    Track capacity over time to predict with some degree of reliability the
    amount of additional storage needed.
   </para>
  </listitem>
 </itemizedlist>
 <para>
  Charts and graphs provide a quick way to visualize large amounts of complex
  data. It is especially useful when trying to find relationships and
  understand your data, which could include thousands or even millions of
  variables. You can create a new chart in &opscon; from
  <emphasis role="bold">My Dashboard</emphasis>.
 </para>
 <para>
  The charts in &opscon; are based on Monasca data. When you create a
  new chart you will be able to select the time range and the metric you want
  to chart. The list of Metrics you can choose from is equivalent to using the
  <emphasis role="bold">monasca metric-name-list</emphasis> on the command
  line. After you select a metric, you can then specify a dimension, which is
  derived from the <emphasis role="bold">monasca metric-list –name
  &lt;metric_name&gt;</emphasis> command line results. The dimension list
  changes based on the selected metric.
 </para>
 <para>
  This topic provides instructions on how to create a basic chart, and how to
  create a chart specifically to visualize your Cinder capacity.
 </para>
 <itemizedlist>
  <listitem>
   <para>
    Create a Chart: <xref linkend="ops-create-charts"/>
   </para>
  </listitem>
  <listitem>
   <para>
    Chart Cinder Capacity: <xref linkend="ops-Cinder-chart"/>
   </para>
  </listitem>
 </itemizedlist>
 <section xml:id="ops-create-charts">
  <title>Create a Chart</title>
  <para>
   Create a chart to visually display data for up to 6 metrics over a period of
   time.
  </para>
  <para>
   To create a chart:
  </para>
  <orderedlist>
   <listitem>
    <para>
     To open &opscon;, in a browser, enter either the URL or Virtual
     IP connected to &opscon;.
    </para>
    <para>
     For example:
    </para>
<screen>https://myardana.test:9095
https://VIP:9095</screen>
   </listitem>
   <listitem>
    <para>
     On the <emphasis role="bold">Home</emphasis> screen, click the menu
     represented by 3 horizontal lines (&opscon-hamburger-icon;).
    </para>
   </listitem>
   <listitem>
    <para>
     From the menu that slides in on the left, select
     <emphasis role="bold">Home</emphasis>, and then
     select <emphasis role="bold">My Dashboard</emphasis>.
    </para>
   </listitem>
   <listitem>
    <para>
     On the <emphasis role="bold">My Dashboard</emphasis> screen, select
     <emphasis role="bold">Create New Chart</emphasis>.
    </para>
   </listitem>
   <listitem>
    <para>
     On the <emphasis role="bold">Add New Time Series Chart</emphasis> screen,
     in <emphasis role="bold">Chart Definition</emphasis> complete any of the
     optional fields:
    </para>
    <variablelist>
     <varlistentry>
      <term>Name</term>
      <listitem>
       <para>
        Short description of chart.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Time Range</term>
      <listitem>
       <para>
        Specifies the interval between metric collection. The default is
        <emphasis role="bold">1 hour</emphasis>. Can be set to hours
        (1,2,4,8,24) or days (7,30,45).
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Chart Update Rate</term>
      <listitem>
       <para>
        Collects metric data and adds it to the chart at the specified
        interval. The default is <emphasis role="bold">1 minute</emphasis>. Can
        be set to minutes (1,5,10,30) or 1 hour.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Chart Type</term>
      <listitem>
       <para>
        Determines how the data is displayed. The default type is
        <emphasis role="bold">Line</emphasis>. Can be set to the following
        values:
       </para>
       <itemizedlist>
        <listitem>
         <informalfigure>
          <mediaobject>
           <imageobject role="fo">
            <imagedata fileref="media-opsconsole-LineChartIcon.png" width="75%"/>
           </imageobject>
           <imageobject role="html">
            <imagedata fileref="media-opsconsole-LineChartIcon.png"/>
           </imageobject>
          </mediaobject>
         </informalfigure>
         <para>
          Line
         </para>
        </listitem>
        <listitem>
         <informalfigure>
          <mediaobject>
           <imageobject role="fo">
            <imagedata fileref="media-opsconsole-BarChartIcon.png" width="75%"/>
           </imageobject>
           <imageobject role="html">
            <imagedata fileref="media-opsconsole-BarChartIcon.png"/>
           </imageobject>
          </mediaobject>
         </informalfigure>
         <para>
          Bar
         </para>
        </listitem>
        <listitem>
         <informalfigure>
          <mediaobject>
           <imageobject role="fo">
            <imagedata fileref="media-opsconsole-StackedBarIcon.png" width="75%"/>
           </imageobject>
           <imageobject role="html">
            <imagedata fileref="media-opsconsole-StackedBarIcon.png"/>
           </imageobject>
          </mediaobject>
         </informalfigure>
         <para>
          Stacked Bar
         </para>
        </listitem>
        <listitem>
         <informalfigure>
          <mediaobject>
           <imageobject role="fo">
            <imagedata fileref="media-opsconsole-AreaIcon.png" width="75%"/>
           </imageobject>
           <imageobject role="html">
            <imagedata fileref="media-opsconsole-AreaIcon.png"/>
           </imageobject>
          </mediaobject>
         </informalfigure>
         <para>
          Area
         </para>
        </listitem>
        <listitem>
         <informalfigure>
          <mediaobject>
           <imageobject role="fo">
            <imagedata fileref="media-opsconsole-AreaStackedIcon.png" width="75%"/>
           </imageobject>
           <imageobject role="html">
            <imagedata fileref="media-opsconsole-AreaStackedIcon.png"/>
           </imageobject>
          </mediaobject>
         </informalfigure>
         <para>
          Stacked Area
         </para>
        </listitem>
       </itemizedlist>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Chart Size</term>
      <listitem>
       <para>
        This controls the visual display of the chart width as it appears on
        <emphasis role="bold">My Dashboard</emphasis>. The default is
        <emphasis role="bold">Small</emphasis>. This field can be set to
        <emphasis role="bold">Small</emphasis> to display it at 50% or
        <emphasis role="bold">Large</emphasis> for 100%.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </listitem>
   <listitem>
    <para>
     On the <emphasis role="bold">Add New Time Series Chart</emphasis> screen,
     in <emphasis role="bold">Added Chart Data</emphasis> complete the
     following fields:
    </para>
    <variablelist>
     <varlistentry>
      <term>Metric</term>
      <listitem>
       <para>
        In Monasca, a metric is a multi-dimensional description that consists
        of the following fields: name, dimensions, timestamp, value and
        value_meta. The pre-populated list is equivalent to using the
        <emphasis role="bold">monasca metric-name-list</emphasis> on the
        command line.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Dimension</term>
      <listitem>
       <para>
        The set of unique dimensions that are defined for a specific metric.
        Dimensions are a dictionary of key-value pairs. This pre-populated list
        is equivalent to using the
        <emphasis role="bold">monasca
        metric-list –name &lt;metric_name&gt;</emphasis> on the command line.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>Function</term>
      <listitem>
       <para>
        &opscon; uses Monasca to provide the results of all
        mathematical functions. Monasca in turns uses Graphite to perform the
        mathematical calculations and return the results. The default is
        <emphasis role="bold">AVG</emphasis>. The
        <emphasis role="bold">Function</emphasis>
        field can be set to
        <emphasis role="bold">AVG</emphasis>
        (default), <emphasis role="bold">MIN</emphasis>,
        <emphasis role="bold">MAX</emphasis>. and
        <emphasis role="bold">COUNT</emphasis>.
        For more information on these functions, see the Graphite
        documentation at
        <link xlink:href="http://www.aosabook.org/en/graphite.html"/>.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </listitem>
   <listitem>
    <para>
     Click <emphasis role="bold">Add Data To Chart</emphasis>. To add another
     metric to the chart, repeat the previous step until all metrics are added.
     The maximum you can have in one chart is 6 metrics.
    </para>
   </listitem>
   <listitem>
    <para>
     To create the chart, click <emphasis role="bold">Create New
     Chart</emphasis>.
    </para>
   </listitem>
  </orderedlist>
  <para>
   After you click <emphasis role="bold">Create New Chart</emphasis>, you will
   be returned to <emphasis>My Dashboard</emphasis> where the new chart will be
   shown. From the <emphasis>My Dashboard</emphasis> screen you can use the menu
   in the top-right corner of the card to
   delete or edit the chart. You can also select an option to create a
   comma-delimited file of the data in the chart.
  </para>
 </section>
 <section xml:id="ops-Cinder-chart">
  <title>Chart Cinder Capacity</title>
  <para>
   To visualize the use of storage capacity over time, you can create a chart
   that graphs the total block storage backend capacity. To find out how much
   of that total is being used, you can also create a chart that graphs the
   available block storage capacity.
  </para>
  <para>
   <emphasis role="bold">Visualizing Cinder:</emphasis>
  </para>
  <itemizedlist>
   <listitem>
    <para>
     Chart Total Capacity: <xref linkend="ops-Cinder-chart-total"/>
    </para>
   </listitem>
   <listitem>
    <para>
     Chart Available Capacity: <xref linkend="ops-Cinder-chart-avail"/>
    </para>
   </listitem>
  </itemizedlist>
  <important>
   <para>
    The total and free capacity values are based on the available capacity
    reported by the Cinder backend. Be aware that some backends can be
    configured to thinly provision.
   </para>
  </important>
 </section>
 <section xml:id="ops-Cinder-chart-total">
  <title>Chart Total Capacity</title>
  <para>
   To chart the total block-storage backend capacity:
  </para>
  <orderedlist>
   <listitem>
    <para>
     Log in to &opscon;.
    </para>
   </listitem>
   <listitem>
    <para>
     Follow the steps in the previous instructions to start creating a chart.
    </para>
   </listitem>
   <listitem>
    <para>
     To chart the total backend capacity, on the <emphasis role="bold">Add New
     Time Series Chart</emphasis> screen, in <emphasis role="bold">Chart
     Definition</emphasis> use the following settings:
    </para>
    <informaltable colsep="1" rowsep="1">
     <tgroup cols="2">
      <colspec colname="c1" colnum="1" colwidth="1*"/>
      <colspec colname="c2" colnum="2" colwidth="19*"/>
      <thead>
       <row>
        <entry>Field</entry>
        <entry>Setting</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>Metrics</entry>
        <entry>cinderlm.cinder.backend.total.size</entry>
       </row>
       <row>
        <entry>Dimension</entry>
        <entry><para>any hostname. If multiple backends are available, select any one. The backends will all return the same metric data.</para></entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </listitem>
   <listitem>
    <para>
     Add the data to the chart and click
     <emphasis role="bold">Create</emphasis>.
    </para>
   </listitem>
  </orderedlist>
  <para>
   Example of a Cinder Total Capacity Chart:
  </para>
 </section>
 <section xml:id="ops-Cinder-chart-avail">
  <title>Chart Available Capacity</title>
  <para>
   To chart the available block-storage backend capacity:
  </para>
  <orderedlist>
   <listitem>
    <para>
     Log in to &opscon;.
    </para>
   </listitem>
   <listitem>
    <para>
     Follow the steps in the previous instructions to start creating a chart.
    </para>
   </listitem>
   <listitem>
    <para>
     To chart the available backend capacity, on the <emphasis role="bold">Add
     New Time Series Chart</emphasis> screen, in <emphasis role="bold">Chart
     Definition</emphasis> use the following settings:
    </para>
    <informaltable colsep="1" rowsep="1">
     <tgroup cols="2">
      <colspec colname="c1" colnum="1" colwidth="1*"/>
      <colspec colname="c2" colnum="2" colwidth="19*"/>
      <thead>
       <row>
        <entry>Field</entry>
        <entry>Setting</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>Metrics</entry>
        <entry>cinderlm.cinder.backend.total.avail</entry>
       </row>
       <row>
        <entry>Dimension</entry>
        <entry><para>any hostname. If multiple backends are available, select any one. The backends will all return the same metric data.</para></entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </listitem>
   <listitem>
    <para>
     Add the data to the chart and click
     <emphasis role="bold">Create</emphasis>.
    </para>
   </listitem>
  </orderedlist>
  <para>
   Example of a chart showing Cinder Available Capacity:
  </para>
  <important>
   <para>
    The source data for the Capacity Summary pages is only refreshed at the top
    of each hour. This affects the latency of the displayed data on those
    pages.
   </para>
  </important>
 </section>
</section>