Skip to content

Commit

Permalink
Add notes for location / facility aggregate graphs
Browse files Browse the repository at this point in the history
  • Loading branch information
barryo committed Sep 17, 2021
1 parent 586b1fc commit cb441ca
Show file tree
Hide file tree
Showing 8 changed files with 115 additions and 84 deletions.
6 changes: 6 additions & 0 deletions docs/grapher/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ By default, the following graphs are **publicly** accessible in **IXP Manager**

1. aggregate bits/sec and packets/sec graphs for the IXP;
2. aggregate bits/sec and packets/sec graphs for the infrastructures;
2. aggregate bits/sec and packets/sec graphs for locations / facilities;
3. aggregate bits/sec graphs on a per-protocol and per-VLAN basis (requires [sflow](../features/sflow.md));
4. aggregate graphs for the switches; and
5. aggregate graphs for the trunk connections.
Expand All @@ -16,6 +17,7 @@ If you wish to limit access to these to a *less than or equal* [user permission]

1. `GRAPHER_ACCESS_IXP`
2. `GRAPHER_ACCESS_INFRASTRUCTURE`
3. `GRAPHER_ACCESS_LOCATION`
3. `GRAPHER_ACCESS_VLAN`
4. `GRAPHER_ACCESS_SWITCH`
5. `GRAPHER_ACCESS_TRUNK`
Expand All @@ -33,6 +35,7 @@ GRAPHER_ACCESS_IXP=1
GRAPHER_ACCESS_INFRASTRUCTURE=1
GRAPHER_ACCESS_VLAN=1
GRAPHER_ACCESS_SWITCH=1
GRAPHER_ACCESS_LOCATION=1
GRAPHER_ACCESS_TRUNK=1
```

Expand Down Expand Up @@ -126,6 +129,8 @@ Let's first look at supported graphs:
* `vlan`: aggregate graph for a specific VLAN. `id`, which is mandatory, is the primary key of the VLAN from the `vlan` database table. [Currently only supported via sflow for `protocol=ipv4|ipv6` and `category=bits|pkts`]


* `location`: aggregate graph of all peering traffic being switched by a specific facility (sum of all customer ports **not including** core ports). `id`, which is mandatory, is the primary key of the location / facility from the `location` database table. [Currently only supported via MRTG for `protocol=all`]. *Note that we are looking at all traffic originating and/or terminating at a location rather than traffic passing through it.

* `switch`: aggregate graph of all peering traffic being switched by a specific switch (sum of all customer ports plus core ports). `id`, which is mandatory, is the primary key of the switch from the `switch` database table. [Currently only supported via MRTG for `protocol=all`]


Expand Down Expand Up @@ -191,6 +196,7 @@ Graph | Default Access Control
`ixp` | public but respects `GRAPHER_ACCESS_IXP` (see above)
`infrastructure` | public but respects `GRAPHER_ACCESS_INFRASTRUCTURE` (see above)
`vlan` | public but respects `GRAPHER_ACCESS_VLAN` (see above), unless it's a private VLAN (in which case only superuser is supported currently)
`location` | public but respects `GRAPHER_ACCESS_LOCATION` (see above)
`switch` | public but respects `GRAPHER_ACCESS_SWITCH` (see above)
`trunk` | public but respects `GRAPHER_ACCESS_TRUNK` (see above)
`physicalinterface` | superuser or user of the owning customer but respects `GRAPHER_ACCESS_CUSTOMER` (see *Access to Member Graphs* below)
Expand Down
9 changes: 9 additions & 0 deletions docs/grapher/mrtg.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ Per-second graphs are generated for bits, packets, errors, discards and broadcas

You'll find examples of [IXP graphs](https://www.inex.ie/ixp/statistics/ixp) and [infrastructure graphs](https://www.inex.ie/ixp/statistics/infrastructure) on INEX's own [IXP Manager](https://www.inex.ie/ixp/) where they are public be default.

* **Location Aggregate Graphs**

These are defined and built automatically from the locations / facilities you have defined and the switches you have assigned to them. These graphs are available from the *Statistics* menu under *Facility Aggregate Graphs*.

These graphs are the aggregate of all peering ports **excluding** core/trunk ports on a given switch. It is the aggregate of traffic originating and/or terminating in a location rather than traffic simply passing through a location.

You'll find examples of [locaiton graphs](https://www.inex.ie/ixp/statistics/location) on INEX's own [IXP Manager](https://www.inex.ie/ixp/) where they are public be default.


* **Switch Aggregate Graphs**

These are defined and built automatically from the switches you have defined. These graphs are available from the *Statistics* menu under *Switch Aggregate Graphs*.
Expand Down
2 changes: 1 addition & 1 deletion site/features/routers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1598,7 +1598,7 @@ <h2 id="filtering-known-transit-networks">Filtering Known Transit Networks<a cla
<div class="md-source-date">
<small>

Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 15, 2021</span>
Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 16, 2021</span>


</small>
Expand Down
10 changes: 10 additions & 0 deletions site/grapher/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1448,6 +1448,7 @@ <h2 id="accessibility-of-aggregate-graphs">Accessibility of Aggregate Graphs<a c
<ol>
<li>aggregate bits/sec and packets/sec graphs for the IXP;</li>
<li>aggregate bits/sec and packets/sec graphs for the infrastructures;</li>
<li>aggregate bits/sec and packets/sec graphs for locations / facilities;</li>
<li>aggregate bits/sec graphs on a per-protocol and per-VLAN basis (requires <a href="../../features/sflow/">sflow</a>);</li>
<li>aggregate graphs for the switches; and</li>
<li>aggregate graphs for the trunk connections.</li>
Expand All @@ -1456,6 +1457,7 @@ <h2 id="accessibility-of-aggregate-graphs">Accessibility of Aggregate Graphs<a c
<ol>
<li><code>GRAPHER_ACCESS_IXP</code></li>
<li><code>GRAPHER_ACCESS_INFRASTRUCTURE</code></li>
<li><code>GRAPHER_ACCESS_LOCATION</code></li>
<li><code>GRAPHER_ACCESS_VLAN</code></li>
<li><code>GRAPHER_ACCESS_SWITCH</code></li>
<li><code>GRAPHER_ACCESS_TRUNK</code></li>
Expand All @@ -1468,6 +1470,7 @@ <h2 id="accessibility-of-aggregate-graphs">Accessibility of Aggregate Graphs<a c
GRAPHER_ACCESS_INFRASTRUCTURE=1
GRAPHER_ACCESS_VLAN=1
GRAPHER_ACCESS_SWITCH=1
GRAPHER_ACCESS_LOCATION=1
GRAPHER_ACCESS_TRUNK=1
</code></pre></div>
<p>If you would prefer to restrict access to these to superusers / admins only, replace <code>=1</code> above with <code>=3</code>.</p>
Expand Down Expand Up @@ -1552,6 +1555,9 @@ <h2 id="api-access">API Access<a class="headerlink" href="#api-access" title="Pe
<p><code>vlan</code>: aggregate graph for a specific VLAN. <code>id</code>, which is mandatory, is the primary key of the VLAN from the <code>vlan</code> database table. [Currently only supported via sflow for <code>protocol=ipv4|ipv6</code> and <code>category=bits|pkts</code>]</p>
</li>
<li>
<p><code>location</code>: aggregate graph of all peering traffic being switched by a specific facility (sum of all customer ports <strong>not including</strong> core ports). <code>id</code>, which is mandatory, is the primary key of the location / facility from the <code>location</code> database table. [Currently only supported via MRTG for <code>protocol=all</code>]. *Note that we are looking at all traffic originating and/or terminating at a location rather than traffic passing through it.</p>
</li>
<li>
<p><code>switch</code>: aggregate graph of all peering traffic being switched by a specific switch (sum of all customer ports plus core ports). <code>id</code>, which is mandatory, is the primary key of the switch from the <code>switch</code> database table. [Currently only supported via MRTG for <code>protocol=all</code>]</p>
</li>
<li>
Expand Down Expand Up @@ -1633,6 +1639,10 @@ <h2 id="access-control">Access Control<a class="headerlink" href="#access-contro
<td>public but respects <code>GRAPHER_ACCESS_VLAN</code> (see above), unless it's a private VLAN (in which case only superuser is supported currently)</td>
</tr>
<tr>
<td><code>location</code></td>
<td>public but respects <code>GRAPHER_ACCESS_LOCATION</code> (see above)</td>
</tr>
<tr>
<td><code>switch</code></td>
<td>public but respects <code>GRAPHER_ACCESS_SWITCH</code> (see above)</td>
</tr>
Expand Down
6 changes: 6 additions & 0 deletions site/grapher/mrtg/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1508,6 +1508,12 @@ <h1 id="backend-mrtg">Backend: MRTG<a class="headerlink" href="#backend-mrtg" ti
<p>You'll find examples of <a href="https://www.inex.ie/ixp/statistics/ixp">IXP graphs</a> and <a href="https://www.inex.ie/ixp/statistics/infrastructure">infrastructure graphs</a> on INEX's own <a href="https://www.inex.ie/ixp/">IXP Manager</a> where they are public be default.</p>
</li>
<li>
<p><strong>Location Aggregate Graphs</strong></p>
<p>These are defined and built automatically from the locations / facilities you have defined and the switches you have assigned to them. These graphs are available from the <em>Statistics</em> menu under <em>Facility Aggregate Graphs</em>.</p>
<p>These graphs are the aggregate of all peering ports <strong>excluding</strong> core/trunk ports on a given switch. It is the aggregate of traffic originating and/or terminating in a location rather than traffic simply passing through a location.</p>
<p>You'll find examples of <a href="https://www.inex.ie/ixp/statistics/location">locaiton graphs</a> on INEX's own <a href="https://www.inex.ie/ixp/">IXP Manager</a> where they are public be default.</p>
</li>
<li>
<p><strong>Switch Aggregate Graphs</strong></p>
<p>These are defined and built automatically from the switches you have defined. These graphs are available from the <em>Statistics</em> menu under <em>Switch Aggregate Graphs</em>.</p>
<p>These graphs are the aggregate of all peering ports <strong>and core/trunk ports</strong> on a given switch. It is the aggregate of traffic being exchanged across a given switch.</p>
Expand Down
2 changes: 1 addition & 1 deletion site/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit cb441ca

Please sign in to comment.