59c8b0f77 · cryptotaxi247/netdata-1

@@ -33,11 +33,6 @@ Additionally, it collects overall device uptime.

33

34 It is compatible with all SNMP versions (v1, v2c, and v3) and uses the [gosnmp](https://github.com/gosnmp/gosnmp) package.

35

36 -**For advanced users**:

37 -

38 -- You can manually specify custom OIDs (Object Identifiers) to retrieve specific data points beyond the default metrics.

39 -- However, defining custom charts with dimensions for these OIDs requires manual configuration.

40 -

36

37

38

@@ -199,20 +194,6 @@ The following options can be defined globally: update_every, autodetection_retry

194 | user.auth_key | Authentication protocol pass phrase. | | no |

195 | user.priv_proto | Privacy protocol for SNMPv3 messages. | | no |

196 | user.priv_key | Privacy protocol pass phrase. | | no |

202 -| charts | List of charts. | [] | yes |

203 -| charts.id | Chart ID. Used to uniquely identify the chart. | | yes |

205 -| charts.units | Chart units. | num | no |

208 -| charts.priority | Chart priority. | 70000 | no |

209 -| charts.multiply_range | Used when you need to define many charts using incremental OIDs. | [] | no |

210 -| charts.dimensions | List of chart dimensions. | [] | yes |

211 -| charts.dimensions.oid | Collected metric OID. | | yes |

212 -| charts.dimensions.name | Dimension name. | | yes |

214 -| charts.dimensions.multiplier | Collected value multiplier, applied to convert it properly to units. | 1 | no |

215 -| charts.dimensions.divisor | Collected value divisor, applied to convert it properly to units. | 1 | no |

197

198 ##### user.auth_proto

199

@@ -311,155 +292,6 @@ jobs:

292 ```

293 </details>

294

314 -##### Custom OIDs

315 -

316 -In this example:

317 -

318 -- the SNMP device is `192.0.2.1`.

319 -- the SNMP version is `2`.

320 -- the SNMP community is `public`.

321 -- we will update the values every 10 seconds.

322 -

323 -

324 -<details open><summary>Config</summary>

325 -

326 -```yaml

327 -jobs:

328 - - name: switch

329 - update_every: 10

330 - hostname: 192.0.2.1

331 - community: public

332 - options:

333 - version: 2

334 - charts:

335 - - id: "bandwidth_port1"

336 - title: "Switch Bandwidth for port 1"

337 - units: "kilobits/s"

338 - type: "area"

339 - family: "ports"

340 - dimensions:

341 - - name: "in"

342 - oid: "1.3.6.1.2.1.2.2.1.10.1"

343 - algorithm: "incremental"

344 - multiplier: 8

345 - divisor: 1000

346 - - name: "out"

347 - oid: "1.3.6.1.2.1.2.2.1.16.1"

348 - multiplier: -8

349 - divisor: 1000

350 - - id: "bandwidth_port2"

351 - title: "Switch Bandwidth for port 2"

352 - units: "kilobits/s"

353 - type: "area"

354 - family: "ports"

355 - dimensions:

356 - - name: "in"

357 - oid: "1.3.6.1.2.1.2.2.1.10.2"

358 - algorithm: "incremental"

359 - multiplier: 8

360 - divisor: 1000

361 - - name: "out"

362 - oid: "1.3.6.1.2.1.2.2.1.16.2"

363 - multiplier: -8

364 - divisor: 1000

365 -

366 -```

367 -</details>

368 -

369 -##### Custom OIDs with multiply range

370 -

371 -If you need to define many charts using incremental OIDs, you can use the `charts.multiply_range` option.

372 -

373 -This is like the SNMPv1/2 example, but the option will multiply the current chart from 1 to 24 inclusive, producing 24 charts in total for the 24 ports of the switch `192.0.2.1`.

374 -

375 -Each of the 24 new charts will have its id (1-24) appended at:

376 -

377 -- its chart unique `id`, i.e. `bandwidth_port_1` to `bandwidth_port_24`.

378 -- its title, i.e. `Switch Bandwidth for port 1` to `Switch Bandwidth for port 24`.

379 -- its `oid` (for all dimensions), i.e. dimension in will be `1.3.6.1.2.1.2.2.1.10.1` to `1.3.6.1.2.1.2.2.1.10.24`.

380 -- its `priority` will be incremented for each chart so that the charts will appear on the dashboard in this order.

381 -

382 -

383 -<details open><summary>Config</summary>

384 -

385 -```yaml

386 -jobs:

387 - - name: switch

388 - update_every: 10

389 - hostname: "192.0.2.1"

390 - community: public

391 - options:

392 - version: 2

393 - charts:

394 - - id: "bandwidth_port"

395 - title: "Switch Bandwidth for port"

396 - units: "kilobits/s"

397 - type: "area"

398 - family: "ports"

399 - multiply_range: [1, 24]

400 - dimensions:

401 - - name: "in"

402 - oid: "1.3.6.1.2.1.2.2.1.10"

403 - algorithm: "incremental"

404 - multiplier: 8

405 - divisor: 1000

406 - - name: "out"

407 - oid: "1.3.6.1.2.1.2.2.1.16"

408 - multiplier: -8

409 - divisor: 1000

410 -

411 -```

412 -</details>

413 -

414 -##### Multiple devices with a common configuration

415 -

416 -YAML supports [anchors](https://yaml.org/spec/1.2.2/#3222-anchors-and-aliases).

417 -The `&` defines and names an anchor, and the `*` uses it. `<<: *anchor` means, inject the anchor, then extend. We can use anchors to share the common configuration for multiple devices.

418 -

419 -The following example:

420 -

421 -- adds an `anchor` to the first job.

422 -- injects (copies) the first job configuration to the second and updates `name` and `hostname` parameters.

423 -- injects (copies) the first job configuration to the third and updates `name` and `hostname` parameters.

424 -

425 -

426 -<details open><summary>Config</summary>

427 -

428 -```yaml

429 -jobs:

430 - - &anchor

431 - name: switch

432 - update_every: 10

433 - hostname: "192.0.2.1"

434 - community: public

435 - options:

436 - version: 2

437 - charts:

438 - - id: "bandwidth_port1"

439 - title: "Switch Bandwidth for port 1"

440 - units: "kilobits/s"

441 - type: "area"

442 - family: "ports"

443 - dimensions:

444 - - name: "in"

445 - oid: "1.3.6.1.2.1.2.2.1.10.1"

446 - algorithm: "incremental"

447 - multiplier: 8

448 - divisor: 1000

449 - - name: "out"

450 - oid: "1.3.6.1.2.1.2.2.1.16.1"

451 - multiplier: -8

452 - divisor: 1000

453 - - <<: *anchor

454 - name: switch2

455 - hostname: "192.0.2.2"

456 - - <<: *anchor

457 - name: switch3

458 - hostname: "192.0.2.3"

459 -

460 -```

461 -</details>

462 -

295

296

297 ## Troubleshooting

Regenerate integrations docs (#20973)