Clarify doc and webui for ignore tag on devices, ports, components and services (#11016)

This commit is contained in:
louis-oui
2020-01-09 23:55:09 +01:00
committed by Kevin Krumm
parent c03c281b6c
commit 063145ebf8
7 changed files with 15 additions and 11 deletions

View File

@@ -30,7 +30,7 @@ path: blob/master/doc/
- [Why is my EdgeRouter device not detected?](#faq25)
- [Why are some of my disks not showing?](#faq26)
- [Why are my disks reporting an incorrect size?](#faq27)
- [What does ignore alert tag on device?](#faq28)
- [What does mean \"ignore alert tag\" on device, component, service and port?](#faq28)
- [Why can't Normal and Global View users see Oxidized?](#faq29)
- [What is the Demo User for?](#faq30)
- [Why does modifying 'Default Alert Template' fail?](#faq31)
@@ -366,10 +366,12 @@ adding to /etc/snmp/snmpd.conf :
`realStorageUnits 0`
## <a name="faq28"> What does ignore alert tag on device?</a>
## <a name="faq28"> What does mean \"ignore alert tag\" on device, component, service and port?</a>
It used to tag a device to not match specific alert rules where
`devices.ignore = 1` condition is is set.
Tag device, component, service and port to ignore alerts. Alert checks will still run.
However, ignore tag can be read in alert rules. For example on device, if `devices.ignore = 0`
or `macros.device = 1` condition is is set and ignore alert tag is on,
the alert rule won't match. The alert rule is ignored.
## <a name="faq8"> How do I add support for a new OS?</a>

View File

@@ -71,13 +71,13 @@ if (Auth::user()->hasGlobalAdmin()) {
</div>
</div>
<div class="form-service row">
<label for='ignore' class='col-sm-3 control-label'>Ignore: </label>
<label for='ignore' class='col-sm-3 control-label'>Ignore alert tag: </label>
<div class="col-sm-9">
<input type='checkbox' id='ignore' name='ignore'>
</div>
</div>
<div class="form-service row">
<label for='disabled' class='col-sm-3 control-label'>Disabled: </label>
<label for='disabled' class='col-sm-3 control-label'>Disable polling and alerting: </label>
<div class="col-sm-9">
<input type='checkbox' id='disabled' name='disabled'>
</div>

View File

@@ -10,7 +10,7 @@
<th data-column-id='label'>Label</th>
<th data-column-id='status'>Status</th>
<th data-column-id='disable' data-sortable='false'>Disable</th>
<th data-column-id='ignore' data-sortable='false'>Ignore</th>
<th data-column-id='ignore' data-sortable='false'>Ignore alert tag</th>
</tr>
</thead>
</table>

View File

@@ -258,7 +258,9 @@ $disable_notify = get_dev_attrib($device, 'disable_notify');
</div>
</div>
<div class="form-group">
<label for="ignore" class="col-sm-2 control-label" title="help">Ignore alert tag:</label>
<label for="ignore" class="col-sm-2 control-label" title="Tag device to ignore alerts. Alert checks will still run.
However, ignore tag can be read in alert rules.
If `devices.ignore = 0` or `macros.device = 1` condition is is set and ignore alert tag is on, the alert rule won't match.">Ignore alert tag:</label>
<div class="col-sm-6">
<input name="ignore" type="checkbox" id="ignore" value="1" data-size="small"
<?php

View File

@@ -16,7 +16,7 @@
<th data-column-id='ifAdminStatus'>Admin</th>
<th data-column-id='ifOperStatus'>Oper</th>
<th data-column-id='disabled' data-sortable='false'>Disable polling</th>
<th data-column-id='ignore' data-sortable='false'>Ignore alerts</th>
<th data-column-id='ignore' data-sortable='false'>Ignore alert tag</th>
<th data-column-id='ifSpeed'>ifSpeed (bits/s)</th>
<th data-column-id='port_tune' data-sortable='false' data-searchable='false'>RRD Tune</th>
<th data-column-id='ifAlias'>Description</th>

View File

@@ -34,7 +34,7 @@ $response[] = array(
'label' => '&nbsp;',
'status' => '<button type="submit" id="warning-select" class="btn btn-default btn-sm" title="Disable alerting on all currently warning components">Warning</button>&nbsp;<button type="submit" id="critical-select" class="btn btn-default btn-sm" title="Disable alerting on all currently critical components">Critical</button>',
'disable' => '<button type="submit" id="disable-toggle" class="btn btn-default btn-sm" title="Toggle polling for all components">Toggle</button><button type="button" id="disable-select" class="btn btn-default btn-sm" title="Disable polling on all components">Select All</button>',
'ignore' => '<button type="submit" id="ignore-toggle" class="btn btn-default btn-sm" title="Toggle alerting for all components">Toggle</button><button type="button" id="ignore-select" class="btn btn-default btn-sm" title="Disable alerting on all components">Select All</button>',
'ignore' => '<button type="submit" id="ignore-toggle" class="btn btn-default btn-sm" title="Toggle alert tag for all components">Toggle</button><button type="button" id="ignore-select" class="btn btn-default btn-sm" title="Disable alert tag on all components">Select All</button>',
);
foreach ($COMPONENTS[$device_id] as $ID => $AVP) {

View File

@@ -40,7 +40,7 @@ $response[] = array(
'ifAdminStatus' => '',
'ifOperStatus' => "<button type='submit' value='Alerted' class='btn btn-default btn-sm' id='alerted-toggle' title='Toggle alerting on all currently-alerted ports'>Alerted</button><button type='submit' value='Down' class='btn btn-default btn-sm' id='down-select' title='Disable alerting on all currently-down ports'>Down</button>",
'disabled' => "<button type='submit' value='Toggle' class='btn btn-default btn-sm' id='disable-toggle' title='Toggle polling for all ports'>Toggle</button><button type='submit' value='Select' class='btn btn-default btn-sm' id='disable-select' title='Disable polling on all ports'>Select All</button>",
'ignore' => "<button type='submit' value='Toggle' class='btn btn-default btn-sm' id='ignore-toggle' title='Toggle alerting for all ports'>Toggle</button><button type='submit' value='Select' class='btn btn-default btn-sm' id='ignore-select' title='Disable alerting on all ports'>Select All</button>",
'ignore' => "<button type='submit' value='Toggle' class='btn btn-default btn-sm' id='ignore-toggle' title='Toggle alert tag for all ports'>Toggle</button><button type='submit' value='Select' class='btn btn-default btn-sm' id='ignore-select' title='Disable alert tag on all ports'>Select All</button>",
'ifAlias' => ''
);