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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-freeradius
     5        plugin_name: go.d.plugin
     6        module_name: freeradius
     7        monitored_instance:
     8          name: FreeRADIUS
     9          link: https://freeradius.org/
    10          categories:
    11            - data-collection.authentication-and-authorization
    12          icon_filename: freeradius.svg
    13        keywords:
    14          - freeradius
    15          - radius
    16        most_popular: false
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        related_resources:
    20          integrations:
    21            list: []
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors FreeRADIUS servers.
    26            
    27            It collect metrics by sending [status-server](https://wiki.freeradius.org/config/Status) messages to the server.
    28          method_description: ""
    29        default_behavior:
    30          auto_detection:
    31            description: |
    32              It automatically detects FreeRadius instances running on localhost.
    33          limits:
    34            description: ""
    35          performance_impact:
    36            description: ""
    37        additional_permissions:
    38          description: ""
    39        multi_instance: true
    40        supported_platforms:
    41          include: []
    42          exclude: []
    43      setup:
    44        prerequisites:
    45          list:
    46            - title: Enable status server
    47              description: |
    48                To enable status server, follow the [official documentation](https://wiki.freeradius.org/config/Status).
    49        configuration:
    50          file:
    51            name: go.d/freeradius.conf
    52          options:
    53            description: |
    54              The following options can be defined globally: update_every, autodetection_retry.
    55            folding:
    56              title: Config options
    57              enabled: true
    58            list:
    59              - name: update_every
    60                description: Data collection frequency.
    61                default_value: 1
    62                required: false
    63              - name: autodetection_retry
    64                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    65                default_value: 0
    66                required: false
    67              - name: address
    68                description: Server address.
    69                default_value: 127.0.0.1
    70                required: true
    71              - name: port
    72                description: Server port.
    73                default_value: 18121
    74                required: false
    75              - name: secret
    76                description: FreeRADIUS secret.
    77                default_value: adminsecret
    78                required: false
    79          examples:
    80            folding:
    81              title: Config
    82              enabled: true
    83            list:
    84              - name: Basic
    85                description: A basic example configuration.
    86                config: |
    87                  jobs:
    88                    - name: local
    89                      address: 127.0.0.1
    90                      port: 18121
    91                      secert: adminsecret
    92              - name: Multi-instance
    93                description: |
    94                  > **Note**: When you define multiple jobs, their names must be unique.
    95                  
    96                  Collecting metrics from local and remote instances.
    97                config: |
    98                  jobs:
    99                    - name: local
   100                      address: 127.0.0.1
   101                      port: 18121
   102                      secert: adminsecret
   103                  
   104                    - name: remote
   105                      address: 192.0.2.1
   106                      port: 18121
   107                      secert: adminsecret
   108      troubleshooting:
   109        problems:
   110          list: []
   111      alerts: []
   112      metrics:
   113        folding:
   114          title: Metrics
   115          enabled: false
   116        description: ""
   117        availability: []
   118        scopes:
   119          - name: global
   120            description: These metrics refer to the entire monitored application.
   121            labels: []
   122            metrics:
   123              - name: freeradius.authentication
   124                description: Authentication
   125                unit: packets/s
   126                chart_type: line
   127                dimensions:
   128                  - name: requests
   129                  - name: responses
   130              - name: freeradius.authentication_access_responses
   131                description: Authentication Responses
   132                unit: packets/s
   133                chart_type: line
   134                dimensions:
   135                  - name: accepts
   136                  - name: rejects
   137                  - name: challenges
   138              - name: freeradius.bad_authentication
   139                description: Bad Authentication Requests
   140                unit: packets/s
   141                chart_type: line
   142                dimensions:
   143                  - name: dropped
   144                  - name: duplicate
   145                  - name: invalid
   146                  - name: malformed
   147                  - name: unknown-types
   148              - name: freeradius.proxy_authentication
   149                description: Authentication
   150                unit: packets/s
   151                chart_type: line
   152                dimensions:
   153                  - name: requests
   154                  - name: responses
   155              - name: freeradius.proxy_authentication_access_responses
   156                description: Authentication Responses
   157                unit: packets/s
   158                chart_type: line
   159                dimensions:
   160                  - name: accepts
   161                  - name: rejects
   162                  - name: challenges
   163              - name: freeradius.proxy_bad_authentication
   164                description: Bad Authentication Requests
   165                unit: packets/s
   166                chart_type: line
   167                dimensions:
   168                  - name: dropped
   169                  - name: duplicate
   170                  - name: invalid
   171                  - name: malformed
   172                  - name: unknown-types
   173              - name: freeradius.accounting
   174                description: Accounting
   175                unit: packets/s
   176                chart_type: line
   177                dimensions:
   178                  - name: requests
   179                  - name: responses
   180              - name: freeradius.bad_accounting
   181                description: Bad Accounting Requests
   182                unit: packets/s
   183                chart_type: line
   184                dimensions:
   185                  - name: dropped
   186                  - name: duplicate
   187                  - name: invalid
   188                  - name: malformed
   189                  - name: unknown-types
   190              - name: freeradius.proxy_accounting
   191                description: Accounting
   192                unit: packets/s
   193                chart_type: line
   194                dimensions:
   195                  - name: requests
   196                  - name: responses
   197              - name: freeradius.proxy_bad_accounting
   198                description: Bad Accounting Requests
   199                unit: packets/s
   200                chart_type: line
   201                dimensions:
   202                  - name: dropped
   203                  - name: duplicate
   204                  - name: invalid
   205                  - name: malformed
   206                  - name: unknown-types