File: how_to.html

package info (click to toggle)
cacti 0.8.6i-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 4,744 kB
  • ctags: 8,967
  • sloc: php: 39,760; sql: 2,306; xml: 678; sh: 487; perl: 133; makefile: 68
file content (152 lines) | stat: -rw-r--r-- 7,261 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">

<html>
<head>
  <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1st August 2004), see www.w3.org">

  <title>How To</title>
  <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
  <link rel="HOME" title="The Cacti Manual" href="index.html">
  <link rel="UP" title="Using Cacti" href="using_cacti.html">
  <link rel="PREVIOUS" title="Using Cacti" href="using_cacti.html">
  <link rel="NEXT" title="Simplest Method of Going from Script to Graph (Walkthrough)" href="script_to_graph.html">
  <link rel="STYLESHEET" type="text/css" href="manual.css">
</head>

<body class="CHAPTER" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
  <div class="NAVHEADER">
    <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
      <tr>
        <th colspan="3" align="center">The Cacti Manual</th>
      </tr>

      <tr>
        <td width="10%" align="left" valign="bottom"><a href="using_cacti.html" accesskey="P">Prev</a></td>

        <td width="80%" align="center" valign="bottom"></td>

        <td width="10%" align="right" valign="bottom"><a href="script_to_graph.html" accesskey="N">Next</a></td>
      </tr>
    </table>
    <hr align="left" width="100%">
  </div>

  <div class="CHAPTER">
    <h1><a name="HOW_TO" id="HOW_TO"></a>Chapter 13. How To</h1>

    <div class="TOC">
      <dl>
        <dt><b>Table of Contents</b></dt>

        <dt><a href="how_to.html#GRAPH_SNMP_OID">Graph a Single SNMP OID</a></dt>

        <dt><a href="script_to_graph.html">Simplest Method of Going from Script to Graph (Walkthrough)</a></dt>
      </dl>
    </div>

    <div class="SECT1">
      <h1 class="SECT1"><a name="GRAPH_SNMP_OID" id="GRAPH_SNMP_OID">Graph a Single SNMP OID</a></h1>

      <p>When dealing with SNMP-enabled devices, there are often times when you want to graph the value of a single OID. This tutorial explains how to do this in Cacti. It also assumes that you have the "SNMP - Generic OID Template" graph template, which is now included in Cacti as of version 0.8.5. If you do not see this template listed under <span class="GUILABEL">Graph Templates</span>, download the template from the Cacti website in XML form and import it using the <span class="GUILABEL">Import Templates</span> menu item.</p>

      <p>To start the process of creating a new graph for your OID, click the <span class="GUILABEL">New Graphs</span> menu item and select the host that contains the target OID from the dropdown. Under the <span class="GUILABEL">Graph Templates</span> box, you will see a dropdown on the last line that reads <span class="GUILABEL">(Select a graph type to create)</span>. From this dropdown, choose "SNMP - Generic OID Template" and click the <span class="GUILABEL">Create</span> button at the bottom of the page.</p>

      <p>You will be presented with several fields that will require input before the new graph can be created. They are described in more detail below.</p>

      <div class="TABLE">
        <a name="AEN1484" id="AEN1484"></a>

        <p><b>Table 13-1. Field Description: SNMP - Generic OID Template</b></p>

        <table border="1" frame="border" rules="all" class="CALSTABLE">
          <col width="1*">
          <col width="3*">

          <thead>
            <tr>
              <th align="center">Name</th>

              <th align="center">Description</th>
            </tr>
          </thead>

          <tbody>
            <tr>
              <td>(Graph) Title</td>

              <td>The title that is to be used for the new graph. It is generally a good idea to keep |host_description| in the title, as to make the graph easier to identify later.</td>
            </tr>

            <tr>
              <td>(Graph) Vertical Label</td>

              <td>The text that will be printed along the y-axis of the graph. It is generally used to describe units, such as 'bytes' or 'percent'.</td>
            </tr>

            <tr>
              <td>(Graph Items) Legend Color</td>

              <td>The color that will be used to reprent the data on the graph.</td>
            </tr>

            <tr>
              <td>(Graph Items) Legend Text</td>

              <td>The text that will be used to describe the data on the graph legend.</td>
            </tr>

            <tr>
              <td>(Data Source) Name</td>

              <td>The title that is to be used for the new data source. It is generally a good idea to keep |host_description| in the title, as to make the data source easier to identify later.</td>
            </tr>

            <tr>
              <td>(Data Source) Maximum Value [snmp_oid]</td>

              <td>The maximum value that will be accepted from the OID. Make sure you choose a value that is reasonable for the data you are trying to graph because anything larger than the maximum will be ignored. If you are graphing a percentage, you should use '100' as the value should never exceed this.</td>
            </tr>

            <tr>
              <td>(Data Source) Data Source Type [snmp_oid]</td>

              <td>How the data from the OID should be stored by RRDTool and interpreted on the graph. If the value of the OID represents the actual data, you should use <span class="GUILABEL">GAUGE</span> for this field. If the OID value is a constantly incrimenting number, you should use <span class="GUILABEL">COUNTER</span> for this field. The two remaining field values, <span class="GUILABEL">DERIVE</span> and <span class="GUILABEL">ABSOLUTE</span> can be ignored in most situations.</td>
            </tr>

            <tr>
              <td>(Custom Data) OID</td>

              <td>The actual SNMP OID to graph. It is typically a good idea to enter the number OID here as opposed to using MIB names. For instance, to get the number of open files on a Netware server, you would use ".1.3.6.1.4.1.23.2.28.2.7.0" as the OID.</td>
            </tr>
          </tbody>
        </table>
      </div>

      <p>When finished filling in values for these fields, click the <span class="GUILABEL">Create</span> button. Your new graph can now be accessed through the <span class="GUILABEL">Graph Management</span> page or the <span class="GUILABEL">Graphs</span> tab inside of Cacti.</p>
    </div>
  </div>

  <div class="NAVFOOTER">
    <hr align="left" width="100%">

    <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
      <tr>
        <td width="33%" align="left" valign="top"><a href="using_cacti.html" accesskey="P">Prev</a></td>

        <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>

        <td width="33%" align="right" valign="top"><a href="script_to_graph.html" accesskey="N">Next</a></td>
      </tr>

      <tr>
        <td width="33%" align="left" valign="top">Using Cacti</td>

        <td width="34%" align="center" valign="top"><a href="using_cacti.html" accesskey="U">Up</a></td>

        <td width="33%" align="right" valign="top">Simplest Method of Going from Script to Graph (Walkthrough)</td>
      </tr>
    </table>
  </div>
</body>
</html>