Repository navigation
Expand file tree
/
Copy pathmain.html
More file actions
183 lines (181 loc) · 9.42 KB
/
Copy pathmain.html
File metadata and controls
183 lines (181 loc) · 9.42 KB
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Getting started — Network Weathermap 2.0</title>
<link rel="stylesheet" href="../manual.css?v=d7053b1ca317">
</head>
<body>
<a class="skip-link" href="#content">Skip to content</a>
<header class="manual-header">
<a class="brand" href="../index.html">Network Weathermap <span>2.0</span></a>
<p>Cacti plugin manual</p>
</header>
<div class="manual-layout">
<nav class="manual-nav" aria-label="Manual sections">
<a aria-current="page" href="main.html">Start here</a><a href=
"editor.html">Editor</a><a href="cacti-plugin.html">Viewing & management</a><a href=
"appearance.html">Appearance & images</a><a href=
"install-cacti.html">Installation</a><a href="upgrading.html">Upgrading</a><a href=
"faq.html">Troubleshooting</a><a href="config-reference.html">Configuration</a><a href=
"targets.html">Data sources</a><a href="advanced.html">Advanced</a><a href=
"cli-reference.html">Command line</a><a href="changes.html">Changes</a><a href=
"errorcodes.html">Error codes</a>
</nav>
<main id="content">
<h1>Getting started</h1>
<span id="introduction"></span>
<p class="lead">Weathermap turns monitored data into a diagram: nodes identify places or
devices; links show direction, traffic and utilisation. Cacti collects the data and generates
historical graphs. Weathermap presents an overview alongside those graphs.</p>
<section id="installation">
<h2>Before you begin</h2>
<p>Use Cacti 1.2.29 or later and the PHP environment required by your Cacti version, with
GD image support. The poller and web server may use different PHP configurations. See
<a href="install-cacti.html">installation</a> and <a href="upgrading.html">upgrading</a>
before changing an existing system.</p>
<p>This is the Cacti-maintained fork. The separate Howard Jones project and its older
releases have different compatibility requirements.</p>
</section>
<span id="running"></span>
<section id="quick-start">
<h2>Create a traffic map</h2>
<ol>
<li>Open Weathermap management with an account allowed to manage maps. Click the
<strong>+</strong> at the right of the green Weather Maps heading. Create a configuration
with a filename and title, then use the <strong>+</strong> beside that file to register it.
Back on the management page, click the map title to open its editor. See the
<a href="cacti-plugin.html#maps">illustrated create-and-register walkthrough</a> for each step.</li>
<li>Choose <strong>Add Node</strong>, then click its position on the canvas. Set a
display name and icon. Add the second endpoint.</li>
<li>Choose <strong>Add Link</strong>, then click the first and second node. The first
node defines the reference direction for IN and OUT.</li>
<li>Open the link properties. Search for the traffic interface by device, port or
description. Select a result, then click <strong>Use interface</strong>. Selection alone
does not apply it.</li>
<li>Set the link capacity, for example <code>1G</code> or <code>500M</code> into the
first node and <code>200M</code> out. Choose <strong>Same As 'In'</strong> when both
capacities are equal.</li>
<li>Save. Check the map in the viewer after its next render, and confirm the selected
Cacti graph is the intended interface.</li>
</ol>
<p>The editor saves individual actions; there is no final whole-map Save button. Dialog
changes require their Save button. Viewer traffic changes when the map is generated, not
continuously as packets pass.</p>
</section>
<section id="basics">
<h2>How to read a map</h2>
<div class="table-scroll">
<table>
<thead>
<tr>
<th scope="col">Element</th>
<th scope="col">Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td>Nodes</td>
<td>An icon or label at a map coordinate. A node can also represent a device
measurement such as CPU, memory or host status.</td>
</tr>
<tr>
<td>Links</td>
<td>Directional arrows between nodes. The measured values come from TARGET sources;
capacity determines the utilisation percentage.</td>
</tr>
<tr>
<td>Colour scale</td>
<td>Maps utilisation or another numeric value to a colour. A warm colour does not
by itself prove a device fault; inspect the configured scale and capacity.</td>
</tr>
<tr>
<td>Comments</td>
<td>Descriptive IN/OUT text, such as a circuit name or capacity. These are separate
from the numeric utilisation labels.</td>
</tr>
<tr>
<td>Hover and click</td>
<td>Hover previews and click destinations show historical graphs or pages. They are
separate from the measurement used to colour the map.</td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="directions">
<h2>Directions, units and capacity</h2>
<p>IN means traffic into the <em>first</em> node in <code>NODES first second</code>; OUT
means traffic out of that node. Verify direction against the corresponding Cacti interface
graph. A reversed endpoint order can make a correct reading look backwards.</p>
<p><code>BANDWIDTH</code> is capacity in bits per second. With the default <code>KILO
1000</code>, <code>1G</code> equals <code>1000M</code>. K, M, G and T are supported. If a
custom map changes KILO, the conversion changes too. New implicit link capacities are 1000M
in each direction; loading a map retains explicitly configured capacities. Changing defaults
through Map Properties is a separate operation: see the
<a href="appearance.html#properties">capacity-editing limitation</a> before doing so.</p>
<p>A 200M reading on a 1G link is 20%. Adding a CPU preview does not change that reading.
Adding another measured traffic source does; see <a href="editor.html#combining">combining
sources</a>.</p>
</section>
<section id="example">
<h2>A small configuration example</h2>
<p>This example uses fixed values, so it needs no live interface. It illustrates the format
rather than providing a production monitoring configuration.</p>
<pre><code>WIDTH 800
HEIGHT 450
TITLE Demonstration network
KILO 1000
KEYPOS 20 330 Traffic utilisation
SCALE DEFAULT 0 50 0 180 0
SCALE DEFAULT 50 80 255 180 0
SCALE DEFAULT 80 100 220 0 0
NODE router
LABEL Router
POSITION 180 180
NODE switch
LABEL Switch
POSITION 620 180
LINK uplink
NODES router switch
BANDWIDTH 1G
TARGET static:200M:100M
OUTCOMMENT Example uplink</code></pre>
<p>For a live map, use the interface picker to insert your actual RRD source and graph
URLs. Do not copy graph IDs or RRD filenames from someone else's installation.</p>
</section>
<section id="security">
<h2>Access and safe administration</h2>
<p>Cacti authentication, plugin realms and map permissions govern the integrated plugin.
Viewing a map does not grant permission to manage it or view every graph referenced by it.
Grant management only to trusted users: raw map syntax and advanced data sources can refer
to server files and external resources.</p>
<p>Use the normal Cacti login and permissions; do not expose old standalone editor scripts
or install an extra Plugin Architecture package. Keep backups outside the web root, follow
Cacti's web-server guidance, and avoid world-writable configuration or image directories.
The external-script data source is disabled in the bundle.</p>
</section>
<span id="alternatives"></span>
<section id="support">
<h2>Help and reporting problems</h2>
<p>Read <a href="faq.html">troubleshooting</a> and the <a href="errorcodes.html">error-code
reference</a>. Report reproducible problems to the <a href=
"https://github.com/Cacti/plugin_weathermap/issues">Cacti Weathermap issue tracker</a>, or
ask on the <a href="https://forums.cacti.net/">Cacti forums</a>. Include versions, relevant
WEATHERMAP log messages and a minimal configuration with credentials and private details
removed.</p>
</section>
<footer>
<p>Network Weathermap 2.0, maintained by The Cacti Group. Based on the original PHP Network
Weathermap and manual by Howard Jones, © 2005–2019; Cacti fork contributions © 2022–2026
The Cacti Group and contributors.</p>
<p><a href="https://github.com/Cacti/plugin_weathermap">Project</a> · <a href=
"https://github.com/Cacti/plugin_weathermap/issues">Report a problem</a> · <a href=
"https://forums.cacti.net/">Cacti forums</a> · <a href="../../LICENSE">License</a> ·
<a href="../../COPYING">Additional license notices</a></p>
</footer>
</main>
</div>
</body>
</html>