summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/filecheck/metadata.yaml
blob: 446226f22e9eb08603f740b25574ea82c6fefce9 (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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-filecheck
      plugin_name: go.d.plugin
      module_name: filecheck
      monitored_instance:
        name: Files and directories
        link: ""
        icon_filename: filesystem.svg
        categories:
          - data-collection.other
      keywords:
        - files
        - directories
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors the existence, last modification time, and size of arbitrary files and directories on the system.
        method_description: ""
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: |
          This collector requires the DAC_READ_SEARCH capability when monitoring files not normally accessible to the Netdata user, but it is set automatically during installation, so no manual configuration is needed.
      default_behavior:
        auto_detection:
          description: ""
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: go.d/filecheck.conf
        options:
          description: |
            The following options can be defined globally: update_every, autodetection_retry.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 10
              required: false
            - name: autodetection_retry
              description: Recheck interval in seconds. Zero means no recheck will be scheduled.
              default_value: 0
              required: false
            - name: files
              description: List of files to monitor.
              default_value: ""
              required: true
              detailed_description: |
                Files matching the selector will be monitored.

                - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
                - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
                - Syntax:

                ```yaml
                files:
                  includes:
                    - pattern1
                    - pattern2
                  excludes:
                    - pattern3
                    - pattern4
                ```
            - name: dirs
              description: List of directories to monitor.
              default_value: ""
              required: true
              detailed_description: |
                Directories matching the selector will be monitored.

                - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
                - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
                - Syntax:

                ```yaml
                dirs:
                  includes:
                    - pattern1
                    - pattern2
                  excludes:
                    - pattern3
                    - pattern4
                ```
            - name: discovery_every
              description: Files and directories discovery interval.
              default_value: 60
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Files
              description: Files monitoring example configuration.
              config: |
                jobs:
                  - name: files_example
                    files:
                      include:
                        - '/path/to/file1'
                        - '/path/to/file2'
                        - '/path/to/*.log'
            - name: Directories
              description: Directories monitoring example configuration.
              config: |
                jobs:
                  - name: files_example
                    dirs:
                      collect_dir_size: no
                      include:
                        - '/path/to/dir1'
                        - '/path/to/dir2'
                        - '/path/to/dir3*'
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: file
          description: These metrics refer to the File.
          labels:
            - name: file_path
              description: File absolute path
          metrics:
            - name: filecheck.file_existence_status
              description: File existence
              unit: status
              chart_type: line
              dimensions:
                - name: exist
                - name: not_exist
            - name: filecheck.file_modification_time_ago
              description: File time since the last modification
              unit: seconds
              chart_type: line
              dimensions:
                - name: mtime_ago
            - name: filecheck.file_size_bytes
              description: File size
              unit: bytes
              chart_type: line
              dimensions:
                - name: size
        - name: directory
          description: These metrics refer to the Directory.
          labels:
            - name: dir_path
              description: Directory absolute path
          metrics:
            - name: filecheck.dir_existence_status
              description: Directory existence
              unit: status
              chart_type: line
              dimensions:
                - name: exist
                - name: not_exist
            - name: filecheck.dir_modification_time_ago
              description: Directory time since the last modification
              unit: seconds
              chart_type: line
              dimensions:
                - name: mtime_ago
            - name: filecheck.dir_size_bytes
              description: Directory size
              unit: bytes
              chart_type: line
              dimensions:
                - name: size
            - name: filecheck.dir_files count
              description: Directory files count
              unit: files
              chart_type: line
              dimensions:
                - name: files