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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-chrony
     5        module_name: chrony
     6        plugin_name: go.d.plugin
     7        monitored_instance:
     8          categories:
     9            - data-collection.system-clock-and-ntp
    10          icon_filename: chrony.jpg
    11          name: Chrony
    12          link: https://chrony.tuxfamily.org/
    13        alternative_monitored_instances: []
    14        keywords: []
    15        info_provided_to_referring_integrations:
    16          description: ""
    17        related_resources:
    18          integrations:
    19            list: []
    20        most_popular: false
    21      overview:
    22        data_collection:
    23          metrics_description: This collector monitors the system's clock performance and peers activity status
    24          method_description: It collects metrics by sending UDP packets to chronyd using the Chrony communication protocol v6.
    25        supported_platforms:
    26          include: []
    27          exclude: []
    28        multi_instance: true
    29        additional_permissions:
    30          description: ""
    31        default_behavior:
    32          auto_detection:
    33            description: |
    34              This collector discovers Chrony instance running on the local host and listening on port 323.
    35              On startup, it tries to collect metrics from:
    36              
    37              - 127.0.0.1:323
    38          limits:
    39            description: ""
    40          performance_impact:
    41            description: ""
    42      setup:
    43        prerequisites:
    44          list: []
    45        configuration:
    46          file:
    47            name: go.d/chrony.conf
    48          options:
    49            description: |
    50              The following options can be defined globally: update_every, autodetection_retry.
    51            folding:
    52              title: Config options
    53              enabled: true
    54            list:
    55              - name: update_every
    56                description: Data collection frequency.
    57                default_value: 5
    58                required: false
    59              - name: autodetection_retry
    60                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    61                default_value: 0
    62                required: false
    63              - name: address
    64                description: Server address. The format is IP:PORT.
    65                default_value: 127.0.0.1:323
    66                required: true
    67              - name: timeout
    68                description: Connection timeout. Zero means no timeout.
    69                default_value: 1
    70                required: false
    71          examples:
    72            folding:
    73              title: Config
    74              enabled: true
    75            list:
    76              - name: Basic
    77                folding:
    78                  enabled: false
    79                description: A basic example configuration.
    80                config: |
    81                  jobs:
    82                    - name: local
    83                      address: 127.0.0.1:323
    84              - name: Multi-instance
    85                description: |
    86                  > **Note**: When you define multiple jobs, their names must be unique.
    87                  
    88                  Collecting metrics from local and remote instances.
    89                config: |
    90                  jobs:
    91                    - name: local
    92                      address: 127.0.0.1:323
    93                  
    94                    - name: remote
    95                      address: 192.0.2.1:323
    96      troubleshooting:
    97        problems:
    98          list: []
    99      alerts: []
   100      metrics:
   101        folding:
   102          title: Metrics
   103          enabled: false
   104        description: ""
   105        availability: []
   106        scopes:
   107          - name: global
   108            description: These metrics refer to the entire monitored application.
   109            labels: []
   110            metrics:
   111              - name: chrony.stratum
   112                availability: []
   113                description: Distance to the reference clock
   114                unit: level
   115                chart_type: line
   116                dimensions:
   117                  - name: stratum
   118              - name: chrony.current_correction
   119                availability: []
   120                description: Current correction
   121                unit: seconds
   122                chart_type: line
   123                dimensions:
   124                  - name: current_correction
   125              - name: chrony.root_delay
   126                availability: []
   127                description: Network path delay to stratum-1
   128                unit: seconds
   129                chart_type: line
   130                dimensions:
   131                  - name: root_delay
   132              - name: chrony.root_dispersion
   133                availability: []
   134                description: Dispersion accumulated back to stratum-1
   135                unit: seconds
   136                chart_type: line
   137                dimensions:
   138                  - name: root_delay
   139              - name: chrony.last_offset
   140                availability: []
   141                description: Offset on the last clock update
   142                unit: seconds
   143                chart_type: line
   144                dimensions:
   145                  - name: offset
   146              - name: chrony.rms_offset
   147                availability: []
   148                description: Long-term average of the offset value
   149                unit: seconds
   150                chart_type: line
   151                dimensions:
   152                  - name: offset
   153              - name: chrony.frequency
   154                availability: []
   155                description: Frequency
   156                unit: ppm
   157                chart_type: line
   158                dimensions:
   159                  - name: frequency
   160              - name: chrony.residual_frequency
   161                availability: []
   162                description: Residual frequency
   163                unit: ppm
   164                chart_type: line
   165                dimensions:
   166                  - name: residual_frequency
   167              - name: chrony.skew
   168                availability: []
   169                description: Skew
   170                unit: ppm
   171                chart_type: line
   172                dimensions:
   173                  - name: skew
   174              - name: chrony.update_interval
   175                availability: []
   176                description: Interval between the last two clock updates
   177                unit: seconds
   178                chart_type: line
   179                dimensions:
   180                  - name: update_interval
   181              - name: chrony.ref_measurement_time
   182                availability: []
   183                description: Time since the last measurement
   184                unit: seconds
   185                chart_type: line
   186                dimensions:
   187                  - name: ref_measurement_time
   188              - name: chrony.leap_status
   189                availability: []
   190                description: Leap status
   191                unit: status
   192                chart_type: line
   193                dimensions:
   194                  - name: normal
   195                  - name: insert_second
   196                  - name: delete_second
   197                  - name: unsynchronised
   198              - name: chrony.activity
   199                availability: []
   200                description: Peers activity
   201                unit: sources
   202                chart_type: stacked
   203                dimensions:
   204                  - name: online
   205                  - name: offline
   206                  - name: burst_online
   207                  - name: burst_offline
   208                  - name: unresolved