github.com/netdata/go.d.plugin@v0.58.1/modules/freeradius/integrations/freeradius.md (about) 1 <!--startmeta 2 custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/freeradius/README.md" 3 meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/freeradius/metadata.yaml" 4 sidebar_label: "FreeRADIUS" 5 learn_status: "Published" 6 learn_rel_path: "Data Collection/Authentication and Authorization" 7 most_popular: False 8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" 9 endmeta--> 10 11 # FreeRADIUS 12 13 14 <img src="https://netdata.cloud/img/freeradius.svg" width="150"/> 15 16 17 Plugin: go.d.plugin 18 Module: freeradius 19 20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 21 22 ## Overview 23 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 28 29 30 31 This collector is supported on all platforms. 32 33 This collector supports collecting metrics from multiple instances of this integration, including remote instances. 34 35 36 ### Default Behavior 37 38 #### Auto-Detection 39 40 It automatically detects FreeRadius instances running on localhost. 41 42 43 #### Limits 44 45 The default configuration for this integration does not impose any limits on data collection. 46 47 #### Performance Impact 48 49 The default configuration for this integration is not expected to impose a significant performance impact on the system. 50 51 52 ## Metrics 53 54 Metrics grouped by *scope*. 55 56 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 57 58 59 60 ### Per FreeRADIUS instance 61 62 These metrics refer to the entire monitored application. 63 64 This scope has no labels. 65 66 Metrics: 67 68 | Metric | Dimensions | Unit | 69 |:------|:----------|:----| 70 | freeradius.authentication | requests, responses | packets/s | 71 | freeradius.authentication_access_responses | accepts, rejects, challenges | packets/s | 72 | freeradius.bad_authentication | dropped, duplicate, invalid, malformed, unknown-types | packets/s | 73 | freeradius.proxy_authentication | requests, responses | packets/s | 74 | freeradius.proxy_authentication_access_responses | accepts, rejects, challenges | packets/s | 75 | freeradius.proxy_bad_authentication | dropped, duplicate, invalid, malformed, unknown-types | packets/s | 76 | freeradius.accounting | requests, responses | packets/s | 77 | freeradius.bad_accounting | dropped, duplicate, invalid, malformed, unknown-types | packets/s | 78 | freeradius.proxy_accounting | requests, responses | packets/s | 79 | freeradius.proxy_bad_accounting | dropped, duplicate, invalid, malformed, unknown-types | packets/s | 80 81 82 83 ## Alerts 84 85 There are no alerts configured by default for this integration. 86 87 88 ## Setup 89 90 ### Prerequisites 91 92 #### Enable status server 93 94 To enable status server, follow the [official documentation](https://wiki.freeradius.org/config/Status). 95 96 97 98 ### Configuration 99 100 #### File 101 102 The configuration file name for this integration is `go.d/freeradius.conf`. 103 104 105 You can edit the configuration file using the `edit-config` script from the 106 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). 107 108 ```bash 109 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata 110 sudo ./edit-config go.d/freeradius.conf 111 ``` 112 #### Options 113 114 The following options can be defined globally: update_every, autodetection_retry. 115 116 117 <details><summary>Config options</summary> 118 119 | Name | Description | Default | Required | 120 |:----|:-----------|:-------|:--------:| 121 | update_every | Data collection frequency. | 1 | no | 122 | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | 123 | address | Server address. | 127.0.0.1 | yes | 124 | port | Server port. | 18121 | no | 125 | secret | FreeRADIUS secret. | adminsecret | no | 126 127 </details> 128 129 #### Examples 130 131 ##### Basic 132 133 A basic example configuration. 134 135 <details><summary>Config</summary> 136 137 ```yaml 138 jobs: 139 - name: local 140 address: 127.0.0.1 141 port: 18121 142 secert: adminsecret 143 144 ``` 145 </details> 146 147 ##### Multi-instance 148 149 > **Note**: When you define multiple jobs, their names must be unique. 150 151 Collecting metrics from local and remote instances. 152 153 154 <details><summary>Config</summary> 155 156 ```yaml 157 jobs: 158 - name: local 159 address: 127.0.0.1 160 port: 18121 161 secert: adminsecret 162 163 - name: remote 164 address: 192.0.2.1 165 port: 18121 166 secert: adminsecret 167 168 ``` 169 </details> 170 171 172 173 ## Troubleshooting 174 175 ### Debug Mode 176 177 To troubleshoot issues with the `freeradius` collector, run the `go.d.plugin` with the debug option enabled. The output 178 should give you clues as to why the collector isn't working. 179 180 - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on 181 your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. 182 183 ```bash 184 cd /usr/libexec/netdata/plugins.d/ 185 ``` 186 187 - Switch to the `netdata` user. 188 189 ```bash 190 sudo -u netdata -s 191 ``` 192 193 - Run the `go.d.plugin` to debug the collector: 194 195 ```bash 196 ./go.d.plugin -d -m freeradius 197 ``` 198 199