@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 131 lines 3.37 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/net.inet.ip.stats.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "net.inet.ip.stats"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Networking"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # net.inet.ip.stats
11
12
13 <img src="https://netdata.cloud/img/network.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: net.inet.ip.stats
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Collect IP stats
24
25 The plugin calls `sysctl` function to collect necessary data.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31
32 ### Default Behavior
33
34 #### Auto-Detection
35
36 This integration doesn't support auto-detection.
37
38 #### Limits
39
40 The default configuration for this integration does not impose any limits on data collection.
41
42 #### Performance Impact
43
44 The default configuration for this integration is not expected to impose a significant performance impact on the system.
45
46 ## Setup
47
48
49 ### Prerequisites
50
51 No action required.
52
53 ### Configuration
54
55 #### Options
56
57
58
59 <details open><summary>Config options</summary>
60
61
62
63 | Option | Description | Default | Required |
64 |:-----|:------------|:--------|:---------:|
65 | ipv4 packets | Enable or disable IPv4 packets metric. | yes | no |
66 | ipv4 fragments sent | Enable or disable IPv4 fragments sent metric. | yes | no |
67 | ipv4 fragments assembly | Enable or disable IPv4 fragments assembly metric. | yes | no |
68 | ipv4 errors | Enable or disable IPv4 errors metric. | yes | no |
69
70
71 </details>
72
73
74
75 #### via File
76
77 The configuration file name for this integration is `netdata.conf`.
78 Configuration for this specific integration is located in the `[plugin:freebsd:net.inet.ip.stats]` section within that file.
79
80 The file format is a modified INI syntax. The general structure is:
81
82 ```ini
83 [section1]
84 option1 = some value
85 option2 = some other value
86
87 [section2]
88 option3 = some third value
89 ```
90 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
91 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
92
93 ```bash
94 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
95 sudo ./edit-config netdata.conf
96 ```
97
98 ##### Examples
99 There are no configuration examples.
100
101
102
103 ## Alerts
104
105 There are no alerts configured by default for this integration.
106
107
108 ## Metrics
109
110 Metrics grouped by *scope*.
111
112 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
113
114
115
116 ### Per net.inet.ip.stats instance
117
118 These metrics show IPv4 connections statistics.
119
120 This scope has no labels.
121
122 Metrics:
123
124 | Metric | Dimensions | Unit |
125 |:------|:----------|:----|
126 | ipv4.packets | received, sent, forwarded, delivered | packets/s |
127 | ipv4.fragsout | ok, failed, created | packets/s |
128 | ipv4.fragsin | ok, failed, all | packets/s |
129 | ipv4.errors | InDiscards, OutDiscards, InHdrErrors, OutNoRoutes, InAddrErrors, InUnknownProtos | packets/s |
130
131