| 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.applications |
| 12 | icon_filename: freeradius.svg |
| 13 | keywords: |
| 14 | - freeradius |
| 15 | - radius |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | related_resources: |
| 19 | integrations: |
| 20 | list: [] |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors FreeRADIUS servers. |
| 25 | |
| 26 | It collect metrics by sending [status-server](https://wiki.freeradius.org/config/Status) messages to the server. |
| 27 | method_description: "" |
| 28 | default_behavior: |
| 29 | auto_detection: |
| 30 | description: | |
| 31 | It automatically detects FreeRadius instances running on localhost. |
| 32 | limits: |
| 33 | description: "" |
| 34 | performance_impact: |
| 35 | description: "" |
| 36 | additional_permissions: |
| 37 | description: "" |
| 38 | multi_instance: true |
| 39 | supported_platforms: |
| 40 | include: [] |
| 41 | exclude: [] |
| 42 | setup: |
| 43 | prerequisites: |
| 44 | list: |
| 45 | - title: Enable status server |
| 46 | description: | |
| 47 | To enable status server, follow the [official documentation](https://wiki.freeradius.org/config/Status). |
| 48 | configuration: |
| 49 | file: |
| 50 | name: go.d/freeradius.conf |
| 51 | options: |
| 52 | description: | |
| 53 | The following options can be defined globally: update_every, autodetection_retry. |
| 54 | folding: |
| 55 | title: Config options |
| 56 | enabled: true |
| 57 | list: |
| 58 | - name: update_every |
| 59 | description: Data collection interval (seconds). |
| 60 | default_value: 1 |
| 61 | required: false |
| 62 | group: Collection |
| 63 | - name: autodetection_retry |
| 64 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 65 | default_value: 0 |
| 66 | required: false |
| 67 | group: Collection |
| 68 | |
| 69 | - name: address |
| 70 | description: FreeRADIUS server address. |
| 71 | default_value: 127.0.0.1 |
| 72 | required: true |
| 73 | group: Target |
| 74 | - name: timeout |
| 75 | description: Connection, read, and write timeout (seconds). |
| 76 | default_value: 1 |
| 77 | required: false |
| 78 | group: Target |
| 79 | - name: port |
| 80 | description: FreeRADIUS server port. |
| 81 | default_value: 18121 |
| 82 | required: false |
| 83 | group: Target |
| 84 | |
| 85 | - name: secret |
| 86 | description: FreeRADIUS shared secret. |
| 87 | default_value: adminsecret |
| 88 | required: false |
| 89 | group: Auth |
| 90 | |
| 91 | - name: vnode |
| 92 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 93 | default_value: "" |
| 94 | required: false |
| 95 | group: Virtual Node |
| 96 | examples: |
| 97 | folding: |
| 98 | title: Config |
| 99 | enabled: true |
| 100 | list: |
| 101 | - name: Basic |
| 102 | description: A basic example configuration. |
| 103 | config: | |
| 104 | jobs: |
| 105 | - name: local |
| 106 | address: 127.0.0.1 |
| 107 | port: 18121 |
| 108 | secert: adminsecret |
| 109 | - name: Multi-instance |
| 110 | description: | |
| 111 | > **Note**: When you define multiple jobs, their names must be unique. |
| 112 | |
| 113 | Collecting metrics from local and remote instances. |
| 114 | config: | |
| 115 | jobs: |
| 116 | - name: local |
| 117 | address: 127.0.0.1 |
| 118 | port: 18121 |
| 119 | secert: adminsecret |
| 120 | |
| 121 | - name: remote |
| 122 | address: 192.0.2.1 |
| 123 | port: 18121 |
| 124 | secert: adminsecret |
| 125 | troubleshooting: |
| 126 | problems: |
| 127 | list: [] |
| 128 | alerts: [] |
| 129 | metrics: |
| 130 | folding: |
| 131 | title: Metrics |
| 132 | enabled: false |
| 133 | description: "" |
| 134 | availability: [] |
| 135 | scopes: |
| 136 | - name: global |
| 137 | description: These metrics refer to the entire monitored application. |
| 138 | labels: [] |
| 139 | metrics: |
| 140 | - name: freeradius.authentication |
| 141 | description: Authentication |
| 142 | unit: packets/s |
| 143 | chart_type: line |
| 144 | dimensions: |
| 145 | - name: requests |
| 146 | - name: responses |
| 147 | - name: freeradius.authentication_access_responses |
| 148 | description: Authentication Responses |
| 149 | unit: packets/s |
| 150 | chart_type: line |
| 151 | dimensions: |
| 152 | - name: accepts |
| 153 | - name: rejects |
| 154 | - name: challenges |
| 155 | - name: freeradius.bad_authentication |
| 156 | description: Bad Authentication Requests |
| 157 | unit: packets/s |
| 158 | chart_type: line |
| 159 | dimensions: |
| 160 | - name: dropped |
| 161 | - name: duplicate |
| 162 | - name: invalid |
| 163 | - name: malformed |
| 164 | - name: unknown-types |
| 165 | - name: freeradius.proxy_authentication |
| 166 | description: Authentication |
| 167 | unit: packets/s |
| 168 | chart_type: line |
| 169 | dimensions: |
| 170 | - name: requests |
| 171 | - name: responses |
| 172 | - name: freeradius.proxy_authentication_access_responses |
| 173 | description: Authentication Responses |
| 174 | unit: packets/s |
| 175 | chart_type: line |
| 176 | dimensions: |
| 177 | - name: accepts |
| 178 | - name: rejects |
| 179 | - name: challenges |
| 180 | - name: freeradius.proxy_bad_authentication |
| 181 | description: Bad Authentication 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.accounting |
| 191 | description: Accounting |
| 192 | unit: packets/s |
| 193 | chart_type: line |
| 194 | dimensions: |
| 195 | - name: requests |
| 196 | - name: responses |
| 197 | - name: freeradius.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 |
| 207 | - name: freeradius.proxy_accounting |
| 208 | description: Accounting |
| 209 | unit: packets/s |
| 210 | chart_type: line |
| 211 | dimensions: |
| 212 | - name: requests |
| 213 | - name: responses |
| 214 | - name: freeradius.proxy_bad_accounting |
| 215 | description: Bad Accounting Requests |
| 216 | unit: packets/s |
| 217 | chart_type: line |
| 218 | dimensions: |
| 219 | - name: dropped |
| 220 | - name: duplicate |
| 221 | - name: invalid |
| 222 | - name: malformed |
| 223 | - name: unknown-types |