netdata/netdata

<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/freeradius/README.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/freeradius/metadata.yaml"
sidebar_label: "FreeRADIUS"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Authentication and Authorization"
most_popular: False
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# FreeRADIUS


<img src="https://netdata.cloud/img/freeradius.svg" width="150"/>


Plugin: go.d.plugin
Module: freeradius

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

This collector monitors FreeRADIUS servers.

It collect metrics by sending [status-server](https://wiki.freeradius.org/config/Status) messages to the server.




This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.


### Default Behavior

#### Auto-Detection

It automatically detects FreeRadius instances running on localhost.


#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.


## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.



### Per FreeRADIUS instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

| Metric | Dimensions | Unit |
|:------|:----------|:----|
| freeradius.authentication | requests, responses | packets/s |
| freeradius.authentication_access_responses | accepts, rejects, challenges | packets/s |
| freeradius.bad_authentication | dropped, duplicate, invalid, malformed, unknown-types | packets/s |
| freeradius.proxy_authentication | requests, responses | packets/s |
| freeradius.proxy_authentication_access_responses | accepts, rejects, challenges | packets/s |
| freeradius.proxy_bad_authentication | dropped, duplicate, invalid, malformed, unknown-types | packets/s |
| freeradius.accounting | requests, responses | packets/s |
| freeradius.bad_accounting | dropped, duplicate, invalid, malformed, unknown-types | packets/s |
| freeradius.proxy_accounting | requests, responses | packets/s |
| freeradius.proxy_bad_accounting | dropped, duplicate, invalid, malformed, unknown-types | packets/s |



## Alerts

There are no alerts configured by default for this integration.


## Setup

### Prerequisites

#### Enable status server

To enable status server, follow the [official documentation](https://wiki.freeradius.org/config/Status).



### Configuration

#### File

The configuration file name for this integration is `go.d/freeradius.conf`.


You can edit the configuration file using the `edit-config` script from the
Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).

```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/freeradius.conf
```
#### Options

The following options can be defined globally: update_every, autodetection_retry.


<details><summary>Config options</summary>

| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| address | Server address. | 127.0.0.1 | yes |
| port | Server port. | 18121 | no |
| secret | FreeRADIUS secret. | adminsecret | no |

</details>

#### Examples

##### Basic

A basic example configuration.

<details><summary>Config</summary>

```yaml
jobs:
  - name: local
    address: 127.0.0.1
    port: 18121
    secert: adminsecret

```
</details>

##### Multi-instance

> **Note**: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.


<details><summary>Config</summary>

```yaml
jobs:
  - name: local
    address: 127.0.0.1
    port: 18121
    secert: adminsecret

  - name: remote
    address: 192.0.2.1
    port: 18121
    secert: adminsecret

```
</details>



## Troubleshooting

### Debug Mode

To troubleshoot issues with the `freeradius` collector, run the `go.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.

- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
  your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.

  ```bash
  cd /usr/libexec/netdata/plugins.d/
  ```

- Switch to the `netdata` user.

  ```bash
  sudo -u netdata -s
  ```

- Run the `go.d.plugin` to debug the collector:

  ```bash
  ./go.d.plugin -d -m freeradius
  ```