Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-11006

Administrator can lookup all existing service monitors and their configuration parameters

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Open (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 1.13.4
    • Fix Version/s: None
    • Component/s: Documentation
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None

      Description

      Current version: development/docs

      If you are an administrator you should be able to see which monitors are available in your OpenNMS installation. To be able to configure and use this service monitors it should be possible to find all available configuration parameters.

      This part of the documentation version related and has to be documented in the version controlled documentation in the module opennms-doc in the source code.

      1. Assign the sub-task for the monitor to your name and "Start / Stop" workflow from JIRA, so we can see somebody is working on it.
      2. Go to GitHub and choose the development/docs branch --> opennms-doc/guide-admin
      3. Use the template for the monitor you want to document (opennms-doc/guide-admin/src/asciidoc/monitors/_template.adoc)
      4. Name the file with the following pattern:

      opennms-doc/guide-admin/src/asciidoc/text/poller/{Name-of-the-monitor-class}.adoc

      5. Include the new created poller.adoc file in 

      guide-admin/src/asciidoc/index.adoc

      6. Write the documentation and GitHub pull request against the development/docs branch
      7. Use in the pull request the JIRA issue number of the sub-task in the subject
      8. Change the status of the JIRA issue to "Resolved", link to the pull request please
      9. Review of the pull request, with possible iterations
      10. Merge pull request into development/docs branch, Sub-Task is set to "Closed"
      11. Assign the Wiki page with the Template:WIP with the issue number and your name (http://www.opennms.org/wiki/Template:WIP)

      FYI about "remote enabled"
      You can look up if a monitor is remote enable, by checking the java class of the monitor for the following annotations.
      If a monitor class carries one of the following annotations it is remote enabled:

      • @ Distributable
      • @ Distributable(DistributionContext.ALL)
      • @ Distributable(DistributionContext.REMOTE_MONITOR)

      If a monitor class carries one of the following annotations it is not remote enabled:

      • @ Distributable(DistributionContext.DAEMON)

        Attachments

        1.
        		 TcpMonitor Sub-task Closed Ronny Trommer
        2.
        		 IcmpMonitor Sub-task Closed Cyrille Bollu
        3.
        		 AvailabilityMonitor Sub-task Closed Ronny Trommer
        4.
        		 HttpMonitor Sub-task Closed Cyrille Bollu
        5.
        		 DnsMonitor Sub-task Closed Ronny Trommer
        6.
        		 Win32ServiceMonitor Sub-task Closed Ronny Trommer
        7.
        		 BgpSessionMonitor Sub-task Closed Ronny Trommer
        8.
        		 BSFMonitor Sub-task Closed Markus Neumann (Inactive)
        9.
        		 CiscoIpSlaMonitor Sub-task Closed Ronny Trommer
        10.
        		 CiscoPingMibMonitor Sub-task Closed Ronny Trommer
        11.
        		 CitrixMonitor Sub-task Closed Ronny Trommer
        12.
        		 DiskUsageMonitor Sub-task Closed Ronny Trommer
        13.
        		 DNSResolutionMonitor Sub-task Closed Ronny Trommer
        14.
        		 DominoIIOPMonitor Sub-task Open Unassigned
        15.
        		 DskTableMonitor Sub-task Open Unassigned
        16.
        		 FtpMonitor Sub-task Closed Marcel Fuhrmann
        17.
        		 GpMonitor Sub-task Open Unassigned
        18.
        		 HostResourceSwRunMonitor Sub-task Closed Ronny Trommer
        19.
        		 HttpPostMonitor Sub-task Closed Ronny Trommer
        20.
        		 HttpsMonitor Sub-task Closed Cyrille Bollu
        21.
        		 ImapMonitor Sub-task Closed Ronny Trommer
        22.
        		 JBossMonitor Sub-task Closed Unassigned
        23.
        		 JDBCMonitor Sub-task Closed Ronny Trommer
        24.
        		 JDBCQueryMonitor Sub-task Closed Markus Neumann (Inactive)
        25.
        		 JDBCStoredProcedureMonitor Sub-task Closed Markus Neumann (Inactive)
        26.
        		 JMXMonitor Sub-task Resolved Marcel Fuhrmann
        27.
        		 JMXSecureMonitor Sub-task Closed Unassigned
        28.
        		 JolokiaBeanMonitor Sub-task Closed Ronny Trommer
        29.
        		 JschSshMonitor Sub-task Open Unassigned
        30.
        		 Jsr160Monitor Sub-task Open Unassigned
        31.
        		 LaTableMonitor Sub-task Open Unassigned
        32.
        		 AsteriskSIPPeerMonitor Sub-task Open Michael Batz
        33.
        		 LdapMonitor Sub-task Closed Cyrille Bollu
        34.
        		 LdapsMonitor Sub-task Closed Cyrille Bollu
        35.
        		 LogMatchTableMonitor Sub-task Open Unassigned
        36.
        		 LoopMonitor Sub-task Open Unassigned
        37.
        		 MailTransportMonitor Sub-task Open Unassigned
        38.
        		 MemcachedMonitor Sub-task Closed Ronny Trommer
        39.
        		 MX4JMonitor Sub-task Closed Unassigned
        40.
        		 NetScalerGroupHealthMonitor Sub-task Closed Alejandro Galue
        41.
        		 NrpeMonitor Sub-task Closed Ronny Trommer
        42.
        		 NtpMonitor Sub-task Closed Cyrille Bollu
        43.
        		 OmsaStorageMonitor Sub-task Closed Marcel Fuhrmann
        44.
        		 OpenManageChassisMonitor Sub-task Closed Cyrille Bollu
        45.
        		 PageSequenceMonitor Sub-task Resolved Ronny Trommer
        46.
        		 PassiveServiceMonitor Sub-task Open Unassigned
        47.
        		 PercMonitor Sub-task Resolved Cyrille Bollu
        48.
        		 Pop3Monitor Sub-task Closed Cyrille Bollu
        49.
        		 PrTableMonitor Sub-task Closed Cyrille Bollu
        50.
        		 SmbMonitor Sub-task Closed Ronny Trommer
        51.
        		 SmtpMonitor Sub-task Resolved Jeff Gehlbach
        52.
        		 SnmpMonitor Sub-task Closed Cyrille Bollu
        53.
        		 SshMonitor Sub-task Closed Cyrille Bollu
        54.
        		 SSLCertMonitor Sub-task Closed Ronny Trommer
        55.
        		 StrafePingMonitor Sub-task Closed Ronny Trommer
        56.
        		 SystemExecuteMonitor Sub-task Closed Ronny Trommer
        57.
        		 TrivialTimeMonitor Sub-task Open Unassigned
        58.
        		 WebMonitor Sub-task Open Unassigned
        59.
        		 WmiMonitor Sub-task Open Unassigned
        60.
        		 JCifsMonitor Sub-task Closed Ronny Trommer
        61.
        		 DhcpMonitor Sub-task Closed Ronny Trommer
        62.
        		 NsclientMonitor Sub-task Open Unassigned
        63.
        		 RadiusAuthMonitor Sub-task Closed Ronny Trommer
        64.
        		 SeleniumMonitor Sub-task Open Unassigned
        65.
        		 XmpMonitor Sub-task Closed Bobby Krupczak (Inactive)
        66.
        		 TaskMonitor Sub-task Open Unassigned
        67.
        		 MobileMsgSequenceMonitor Sub-task Open Unassigned
        68.
        		 SMSPingMonitor Sub-task Open Unassigned
        69.
        		 EndPointMonitor Sub-task Open Unassigned
        70.
        		 VmwareCimMonitor Sub-task Resolved Ronny Trommer
        71.
        		 VmwareMonitor Sub-task Resolved Ronny Trommer
        72.
        		 Add default values to monitor docs Sub-task Closed Ronny Trommer
        73.
        		 Remove available since fields Sub-task Closed Markus Neumann (Inactive)
        74.
        		 ImapMonitor: Add more internal information about the test is done Sub-task Closed Ronny Trommer
        75.
        		 Include IcmpMonitor in main doc Sub-task Closed Ronny Trommer
        76.
        		 Fix format issues in template for monitors Sub-task Closed Ronny Trommer
        77.
        		 Remove capsd part from BgpSessionMonitor Sub-task Closed Ronny Trommer
        78.
        		 Improve readability of SnmpMonitor Sub-task Closed Ronny Trommer

          Activity

            People

            Assignee:
            indigo Ronny Trommer
            Reporter:
            indigo Ronny Trommer
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated: