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

Administrator can lookup all existing service monitors and their configuration parameters

    XMLWordPrintable

Details

    • Epic
    • Status: Open (View Workflow)
    • Minor
    • Resolution: Unresolved
    • 1.13.4
    • None
    • Documentation
    • Security Level: Default (Default Security Scheme)
    • None
    • Administrator can lookup all existing service monitors
    • Sprint 1, Sprint 2
    • DB

    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

        Issue Links

          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.
          FtpMonitor Sub-task Closed Marcel Fuhrmann
          15.
          HostResourceSwRunMonitor Sub-task Closed Ronny Trommer
          16.
          HttpPostMonitor Sub-task Closed Ronny Trommer
          17.
          HttpsMonitor Sub-task Closed Cyrille Bollu
          18.
          ImapMonitor Sub-task Closed Ronny Trommer
          19.
          JBossMonitor Sub-task Closed Unassigned
          20.
          JDBCMonitor Sub-task Closed Ronny Trommer
          21.
          JDBCQueryMonitor Sub-task Closed Markus Neumann (Inactive)
          22.
          JDBCStoredProcedureMonitor Sub-task Closed Markus Neumann (Inactive)
          23.
          JMXMonitor Sub-task Resolved Marcel Fuhrmann
          24.
          JMXSecureMonitor Sub-task Closed Unassigned
          25.
          JolokiaBeanMonitor Sub-task Closed Ronny Trommer
          26.
          LdapMonitor Sub-task Closed Cyrille Bollu
          27.
          LdapsMonitor Sub-task Closed Cyrille Bollu
          28.
          MailTransportMonitor Sub-task Resolved Dino Yancey
          29.
          MemcachedMonitor Sub-task Closed Ronny Trommer
          30.
          MX4JMonitor Sub-task Closed Unassigned
          31.
          NetScalerGroupHealthMonitor Sub-task Closed Alejandro Galue
          32.
          NrpeMonitor Sub-task Closed Ronny Trommer
          33.
          NtpMonitor Sub-task Closed Cyrille Bollu
          34.
          OmsaStorageMonitor Sub-task Closed Marcel Fuhrmann
          35.
          OpenManageChassisMonitor Sub-task Closed Cyrille Bollu
          36.
          PageSequenceMonitor Sub-task Resolved Ronny Trommer
          37.
          PercMonitor Sub-task Resolved Cyrille Bollu
          38.
          Pop3Monitor Sub-task Closed Cyrille Bollu
          39.
          PrTableMonitor Sub-task Closed Cyrille Bollu
          40.
          SmbMonitor Sub-task Closed Ronny Trommer
          41.
          SmtpMonitor Sub-task Resolved Jeff Gehlbach
          42.
          SnmpMonitor Sub-task Closed Cyrille Bollu
          43.
          SshMonitor Sub-task Closed Cyrille Bollu
          44.
          SSLCertMonitor Sub-task Closed Ronny Trommer
          45.
          StrafePingMonitor Sub-task Closed Ronny Trommer
          46.
          SystemExecuteMonitor Sub-task Closed Ronny Trommer
          47.
          JCifsMonitor Sub-task Closed Ronny Trommer
          48.
          DhcpMonitor Sub-task Closed Ronny Trommer
          49.
          RadiusAuthMonitor Sub-task Closed Ronny Trommer
          50.
          XmpMonitor Sub-task Closed Bobby Krupczak (Inactive)
          51.
          VmwareCimMonitor Sub-task Resolved Ronny Trommer
          52.
          VmwareMonitor Sub-task Resolved Ronny Trommer
          53.
          Add default values to monitor docs Sub-task Closed Ronny Trommer
          54.
          Remove available since fields Sub-task Closed Markus Neumann (Inactive)
          55.
          ImapMonitor: Add more internal information about the test is done Sub-task Closed Ronny Trommer
          56.
          Include IcmpMonitor in main doc Sub-task Closed Ronny Trommer
          57.
          Fix format issues in template for monitors Sub-task Closed Ronny Trommer
          58.
          Remove capsd part from BgpSessionMonitor Sub-task Closed Ronny Trommer
          59.
          Improve readability of SnmpMonitor Sub-task Closed Ronny Trommer
          60.
          SnmpInterfacePoller Sub-task Resolved Unassigned

          Activity

            People

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

              Dates

                Created:
                Updated: