github.com/netdata/go.d.plugin@v0.58.1/modules/ntpd/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-ntpd
     5        plugin_name: go.d.plugin
     6        module_name: ntpd
     7        monitored_instance:
     8          name: NTPd
     9          link: https://www.ntp.org/documentation/4.2.8-series/ntpd
    10          icon_filename: ntp.png
    11          categories:
    12            - data-collection.system-clock-and-ntp
    13        keywords:
    14          - ntpd
    15          - ntp
    16          - time
    17        related_resources:
    18          integrations:
    19            list: []
    20        info_provided_to_referring_integrations:
    21          description: ""
    22        most_popular: false
    23      overview:
    24        data_collection:
    25          metrics_description: >
    26            This collector monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers)
    27            using the NTP Control Message Protocol via UDP socket, similar to `ntpq`,
    28            the [standard NTP query program](https://doc.ntp.org/current-stable/ntpq.html).
    29          method_description: ""
    30        supported_platforms:
    31          include: []
    32          exclude: []
    33        multi_instance: true
    34        additional_permissions:
    35          description: ""
    36        default_behavior:
    37          auto_detection:
    38            description: ""
    39          limits:
    40            description: ""
    41          performance_impact:
    42            description: ""
    43      setup:
    44        prerequisites:
    45          list: []
    46        configuration:
    47          file:
    48            name: go.d/ntpd.conf
    49          options:
    50            description: |
    51              The following options can be defined globally: update_every, autodetection_retry.
    52            folding:
    53              title: Config options
    54              enabled: true
    55            list:
    56              - name: update_every
    57                description: Data collection frequency.
    58                default_value: 1
    59                required: false
    60              - name: autodetection_retry
    61                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    62                default_value: 0
    63                required: false
    64              - name: address
    65                description: Server address in IP:PORT format.
    66                default_value: 127.0.0.1:123
    67                required: true
    68              - name: timeout
    69                description: Connection/read/write timeout.
    70                default_value: 3
    71                required: false
    72              - name: collect_peers
    73                description: Determines whether peer metrics will be collected.
    74                default_value: false
    75                required: false
    76          examples:
    77            folding:
    78              title: Config
    79              enabled: true
    80            list:
    81              - name: Basic
    82                description: A basic example configuration.
    83                config: |
    84                  jobs:
    85                    - name: local
    86                      address: 127.0.0.1:123
    87              - name: With peers metrics
    88                description: Collect peers metrics.
    89                config: |
    90                  jobs:
    91                    - name: local
    92                      address: 127.0.0.1:123
    93                      collect_peers: yes
    94              - name: Multi-instance
    95                description: |
    96                  > **Note**: When you define multiple jobs, their names must be unique.
    97                  
    98                  Collecting metrics from local and remote instances.
    99                config: |
   100                  jobs:
   101                    - name: local
   102                      address: 127.0.0.1:123
   103                  
   104                    - name: remote
   105                      address: 203.0.113.0:123
   106      troubleshooting:
   107        problems:
   108          list: []
   109      alerts: []
   110      metrics:
   111        folding:
   112          title: Metrics
   113          enabled: false
   114        description: ""
   115        availability: []
   116        scopes:
   117          - name: global
   118            description: These metrics refer to the entire monitored application.
   119            labels: []
   120            metrics:
   121              - name: ntpd.sys_offset
   122                description: Combined offset of server relative to this host
   123                unit: milliseconds
   124                chart_type: area
   125                dimensions:
   126                  - name: offset
   127              - name: ntpd.sys_jitter
   128                description: Combined system jitter and clock jitter
   129                unit: milliseconds
   130                chart_type: line
   131                dimensions:
   132                  - name: system
   133                  - name: clock
   134              - name: ntpd.sys_frequency
   135                description: Frequency offset relative to hardware clock
   136                unit: ppm
   137                chart_type: area
   138                dimensions:
   139                  - name: frequency
   140              - name: ntpd.sys_wander
   141                description: Clock frequency wander
   142                unit: ppm
   143                chart_type: area
   144                dimensions:
   145                  - name: clock
   146              - name: ntpd.sys_rootdelay
   147                description: Total roundtrip delay to the primary reference clock
   148                unit: milliseconds
   149                chart_type: area
   150                dimensions:
   151                  - name: delay
   152              - name: ntpd.sys_rootdisp
   153                description: Total root dispersion to the primary reference clock
   154                unit: milliseconds
   155                chart_type: area
   156                dimensions:
   157                  - name: dispersion
   158              - name: ntpd.sys_stratum
   159                description: Stratum
   160                unit: stratum
   161                chart_type: line
   162                dimensions:
   163                  - name: stratum
   164              - name: ntpd.sys_tc
   165                description: Time constant and poll exponent
   166                unit: log2
   167                chart_type: line
   168                dimensions:
   169                  - name: current
   170                  - name: minimum
   171              - name: ntpd.sys_precision
   172                description: Precision
   173                unit: log2
   174                chart_type: line
   175                dimensions:
   176                  - name: precision
   177          - name: peer
   178            description: These metrics refer to the NTPd peer.
   179            labels:
   180              - name: peer_address
   181                description: peer's source IP address
   182            metrics:
   183              - name: ntpd.peer_offset
   184                description: Peer offset
   185                unit: milliseconds
   186                chart_type: line
   187                dimensions:
   188                  - name: offset
   189              - name: ntpd.peer_delay
   190                description: Peer delay
   191                unit: milliseconds
   192                chart_type: line
   193                dimensions:
   194                  - name: delay
   195              - name: ntpd.peer_dispersion
   196                description: Peer dispersion
   197                unit: milliseconds
   198                chart_type: line
   199                dimensions:
   200                  - name: dispersion
   201              - name: ntpd.peer_jitter
   202                description: Peer jitter
   203                unit: milliseconds
   204                chart_type: line
   205                dimensions:
   206                  - name: jitter
   207              - name: ntpd.peer_xleave
   208                description: Peer interleave delay
   209                unit: milliseconds
   210                chart_type: line
   211                dimensions:
   212                  - name: xleave
   213              - name: ntpd.peer_rootdelay
   214                description: Peer roundtrip delay to the primary reference clock
   215                unit: milliseconds
   216                chart_type: line
   217                dimensions:
   218                  - name: rootdelay
   219              - name: ntpd.peer_rootdisp
   220                description: Peer root dispersion to the primary reference clock
   221                unit: milliseconds
   222                chart_type: line
   223                dimensions:
   224                  - name: dispersion
   225              - name: ntpd.peer_stratum
   226                description: Peer stratum
   227                unit: stratum
   228                chart_type: line
   229                dimensions:
   230                  - name: stratum
   231              - name: ntpd.peer_hmode
   232                description: Peer host mode
   233                unit: hmode
   234                chart_type: line
   235                dimensions:
   236                  - name: hmode
   237              - name: ntpd.peer_pmode
   238                description: Peer mode
   239                unit: pmode
   240                chart_type: line
   241                dimensions:
   242                  - name: pmode
   243              - name: ntpd.peer_hpoll
   244                description: Peer host poll exponent
   245                unit: log2
   246                chart_type: line
   247                dimensions:
   248                  - name: hpoll
   249              - name: ntpd.peer_ppoll
   250                description: Peer poll exponent
   251                unit: log2
   252                chart_type: line
   253                dimensions:
   254                  - name: ppoll
   255              - name: ntpd.peer_precision
   256                description: Peer precision
   257                unit: log2
   258                chart_type: line
   259                dimensions:
   260                  - name: precision