summaryrefslogtreecommitdiffstats
path: root/collectors/nfacct.plugin/metadata.yaml
blob: 943471a37017deeb89da10e46f988854550e87ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
plugin_name: nfacct.plugin
modules:
  - meta:
      plugin_name: nfacct.plugin
      module_name: nfacct.plugin
      monitored_instance:
        name: Netfilter
        link: 'https://www.netfilter.org/'
        categories:
          - data-collection.linux-systems.firewall-metrics
        icon_filename: 'netfilter.png'
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ''
      keywords: []
      most_popular: false
    overview:
      data_collection:
        metrics_description: 'Monitor Netfilter metrics for optimal packet filtering and manipulation. Keep tabs on packet counts, dropped packets, and error rates to secure network operations.'
        method_description: 'Netdata uses libmnl (https://www.netfilter.org/projects/libmnl/index.html) to collect information.'
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: 'This plugin needs setuid.'
      default_behavior:
        auto_detection:
          description: 'This plugin uses socket to connect with netfilter to collect data'
        limits:
          description: ''
        performance_impact:
          description: ''
    setup:
      prerequisites:
        list:
          - title: Install required packages
            description: |
              Install `libmnl-dev` and `libnetfilter-acct-dev` using the package manager of your system.
      configuration:
        file:
          name: 'netdata.conf'
          section_name: '[plugin:nfacct]'
          description: 'This is netdata main configuration file'
        options:
          description: ''
          folding:
            title: 'Config options'
            enabled: true
          list:
            - name: update every
              description: Data collection frequency.
              default_value: 1
              required: false
            - name: command options
              description: Additinal parameters for collector
              default_value: ""
              required: false
        examples:
          folding:
            enabled: true
            title: ''
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: ""
          labels: []
          metrics:
            - name: netfilter.netlink_new
              description: Connection Tracker New Connections
              unit: "connections/s"
              chart_type: line
              dimensions:
                - name: new
                - name: ignore
                - name: invalid
            - name: netfilter.netlink_changes
              description: Connection Tracker Changes
              unit: "changes/s"
              chart_type: line
              dimensions:
                - name: insert
                - name: delete
                - name: delete_list
            - name: netfilter.netlink_search
              description: Connection Tracker Searches
              unit: "searches/s"
              chart_type: line
              dimensions:
                - name: searched
                - name: search_restart
                - name: found
            - name: netfilter.netlink_errors
              description: Connection Tracker Errors
              unit: "events/s"
              chart_type: line
              dimensions:
                - name: icmp_error
                - name: insert_failed
                - name: drop
                - name: early_drop
            - name: netfilter.netlink_expect
              description: Connection Tracker Expectations
              unit: "expectations/s"
              chart_type: line
              dimensions:
                - name: created
                - name: deleted
                - name: new
            - name: netfilter.nfacct_packets
              description: Netfilter Accounting Packets
              unit: "packets/s"
              chart_type: line
              dimensions:
                - name: a dimension per nfacct object
            - name: netfilter.nfacct_bytes
              description: Netfilter Accounting Bandwidth
              unit: "kilobytes/s"
              chart_type: line
              dimensions:
                - name: a dimension per nfacct object