github.com/netdata/go.d.plugin@v0.58.1/modules/fluentd/integrations/fluentd.md (about) 1 <!--startmeta 2 custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/fluentd/README.md" 3 meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/fluentd/metadata.yaml" 4 sidebar_label: "Fluentd" 5 learn_status: "Published" 6 learn_rel_path: "Data Collection/Logs Servers" 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 # Fluentd 12 13 14 <img src="https://netdata.cloud/img/fluentd.svg" width="150"/> 15 16 17 Plugin: go.d.plugin 18 Module: fluentd 19 20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 21 22 ## Overview 23 24 This collector monitors Fluentd servers. 25 26 27 28 29 This collector is supported on all platforms. 30 31 This collector supports collecting metrics from multiple instances of this integration, including remote instances. 32 33 34 ### Default Behavior 35 36 #### Auto-Detection 37 38 This integration doesn't support auto-detection. 39 40 #### Limits 41 42 The default configuration for this integration does not impose any limits on data collection. 43 44 #### Performance Impact 45 46 The default configuration for this integration is not expected to impose a significant performance impact on the system. 47 48 49 ## Metrics 50 51 Metrics grouped by *scope*. 52 53 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 54 55 56 57 ### Per Fluentd instance 58 59 These metrics refer to the entire monitored application. 60 61 This scope has no labels. 62 63 Metrics: 64 65 | Metric | Dimensions | Unit | 66 |:------|:----------|:----| 67 | fluentd.retry_count | a dimension per plugin | count | 68 | fluentd.buffer_queue_length | a dimension per plugin | queue_length | 69 | fluentd.buffer_total_queued_size | a dimension per plugin | queued_size | 70 71 72 73 ## Alerts 74 75 There are no alerts configured by default for this integration. 76 77 78 ## Setup 79 80 ### Prerequisites 81 82 #### Enable monitor agent 83 84 To enable monitor agent, follow the [official documentation](https://docs.fluentd.org/v1.0/articles/monitoring-rest-api). 85 86 87 88 ### Configuration 89 90 #### File 91 92 The configuration file name for this integration is `go.d/fluentd.conf`. 93 94 95 You can edit the configuration file using the `edit-config` script from the 96 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). 97 98 ```bash 99 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata 100 sudo ./edit-config go.d/fluentd.conf 101 ``` 102 #### Options 103 104 The following options can be defined globally: update_every, autodetection_retry. 105 106 107 <details><summary>Config options</summary> 108 109 | Name | Description | Default | Required | 110 |:----|:-----------|:-------|:--------:| 111 | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | 112 | url | Server URL. | http://127.0.0.1:24220 | yes | 113 | timeout | HTTP request timeout. | 2 | no | 114 | username | Username for basic HTTP authentication. | | no | 115 | password | Password for basic HTTP authentication. | | no | 116 | proxy_url | Proxy URL. | | no | 117 | proxy_username | Username for proxy basic HTTP authentication. | | no | 118 | proxy_password | Password for proxy basic HTTP authentication. | | no | 119 | method | HTTP request method. | GET | no | 120 | body | HTTP request body. | | no | 121 | headers | HTTP request headers. | | no | 122 | not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | 123 | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | 124 | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | 125 | tls_cert | Client TLS certificate. | | no | 126 | tls_key | Client TLS key. | | no | 127 128 </details> 129 130 #### Examples 131 132 ##### Basic 133 134 A basic example configuration. 135 136 ```yaml 137 jobs: 138 - name: local 139 url: http://127.0.0.1:24220 140 141 ``` 142 ##### HTTP authentication 143 144 Basic HTTP authentication. 145 146 <details><summary>Config</summary> 147 148 ```yaml 149 jobs: 150 - name: local 151 url: http://127.0.0.1:24220 152 username: username 153 password: password 154 155 ``` 156 </details> 157 158 ##### HTTPS with self-signed certificate 159 160 Fluentd with enabled HTTPS and self-signed certificate. 161 162 <details><summary>Config</summary> 163 164 ```yaml 165 jobs: 166 - name: local 167 url: https://127.0.0.1:24220 168 tls_skip_verify: yes 169 170 ``` 171 </details> 172 173 ##### Multi-instance 174 175 > **Note**: When you define multiple jobs, their names must be unique. 176 177 Collecting metrics from local and remote instances. 178 179 180 <details><summary>Config</summary> 181 182 ```yaml 183 jobs: 184 - name: local 185 url: http://127.0.0.1:24220 186 187 - name: remote 188 url: http://192.0.2.1:24220 189 190 ``` 191 </details> 192 193 194 195 ## Troubleshooting 196 197 ### Debug Mode 198 199 To troubleshoot issues with the `fluentd` collector, run the `go.d.plugin` with the debug option enabled. The output 200 should give you clues as to why the collector isn't working. 201 202 - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on 203 your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. 204 205 ```bash 206 cd /usr/libexec/netdata/plugins.d/ 207 ``` 208 209 - Switch to the `netdata` user. 210 211 ```bash 212 sudo -u netdata -s 213 ``` 214 215 - Run the `go.d.plugin` to debug the collector: 216 217 ```bash 218 ./go.d.plugin -d -m fluentd 219 ``` 220 221