github.com/netdata/go.d.plugin@v0.58.1/modules/filecheck/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-filecheck
     5        plugin_name: go.d.plugin
     6        module_name: filecheck
     7        monitored_instance:
     8          name: Files and directories
     9          link: ""
    10          icon_filename: filesystem.svg
    11          categories:
    12            - data-collection.linux-systems
    13        keywords:
    14          - files
    15          - directories
    16        related_resources:
    17          integrations:
    18            list: []
    19        info_provided_to_referring_integrations:
    20          description: ""
    21        most_popular: false
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors files and directories.
    26          method_description: ""
    27        supported_platforms:
    28          include: []
    29          exclude: []
    30        multi_instance: true
    31        additional_permissions:
    32          description: |
    33            This collector requires the DAC_READ_SEARCH capability, but it is set automatically during installation, so no manual configuration is needed.
    34        default_behavior:
    35          auto_detection:
    36            description: ""
    37          limits:
    38            description: ""
    39          performance_impact:
    40            description: ""
    41      setup:
    42        prerequisites:
    43          list: []
    44        configuration:
    45          file:
    46            name: go.d/filecheck.conf
    47          options:
    48            description: |
    49              The following options can be defined globally: update_every, autodetection_retry.
    50            folding:
    51              title: Config options
    52              enabled: true
    53            list:
    54              - name: update_every
    55                description: Data collection frequency.
    56                default_value: 10
    57                required: false
    58              - name: autodetection_retry
    59                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    60                default_value: 0
    61                required: false
    62              - name: files
    63                description: List of files to monitor.
    64                default_value: ""
    65                required: true
    66                detailed_description: |
    67                  Files matching the selector will be monitored.
    68  
    69                  - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
    70                  - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
    71                  - Syntax:
    72  
    73                  ```yaml
    74                  files:
    75                    includes:
    76                      - pattern1
    77                      - pattern2
    78                    excludes:
    79                      - pattern3
    80                      - pattern4
    81                  ```
    82              - name: dirs
    83                description: List of directories to monitor.
    84                default_value: ""
    85                required: true
    86                detailed_description: |
    87                  Directories matching the selector will be monitored.
    88  
    89                  - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
    90                  - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
    91                  - Syntax:
    92  
    93                  ```yaml
    94                  dirs:
    95                    includes:
    96                      - pattern1
    97                      - pattern2
    98                    excludes:
    99                      - pattern3
   100                      - pattern4
   101                  ```
   102              - name: discovery_every
   103                description: Files and directories discovery interval.
   104                default_value: 60
   105                required: false
   106          examples:
   107            folding:
   108              title: Config
   109              enabled: true
   110            list:
   111              - name: Files
   112                description: Files monitoring example configuration.
   113                config: |
   114                  jobs:
   115                    - name: files_example
   116                      files:
   117                        include:
   118                          - '/path/to/file1'
   119                          - '/path/to/file2'
   120                          - '/path/to/*.log'
   121              - name: Directories
   122                description: Directories monitoring example configuration.
   123                config: |
   124                  jobs:
   125                    - name: files_example
   126                      dirs:
   127                        collect_dir_size: no
   128                        include:
   129                          - '/path/to/dir1'
   130                          - '/path/to/dir2'
   131                          - '/path/to/dir3*'
   132      troubleshooting:
   133        problems:
   134          list: []
   135      alerts: []
   136      metrics:
   137        folding:
   138          title: Metrics
   139          enabled: false
   140        description: ""
   141        availability: []
   142        scopes:
   143          - name: global
   144            description: TBD
   145            labels: []
   146            metrics:
   147              - name: filecheck.file_existence
   148                description: 'File Existence (0: not exists, 1: exists)'
   149                unit: boolean
   150                chart_type: line
   151                dimensions:
   152                  - name: a dimension per file
   153              - name: filecheck.file_mtime_ago
   154                description: File Time Since the Last Modification
   155                unit: seconds
   156                chart_type: line
   157                dimensions:
   158                  - name: a dimension per file
   159              - name: filecheck.file_size
   160                description: File Size
   161                unit: bytes
   162                chart_type: line
   163                dimensions:
   164                  - name: a dimension per file
   165              - name: filecheck.dir_existence
   166                description: 'Dir Existence (0: not exists, 1: exists)'
   167                unit: boolean
   168                chart_type: line
   169                dimensions:
   170                  - name: a dimension per directory
   171              - name: filecheck.dir_mtime_ago
   172                description: Dir Time Since the Last Modification
   173                unit: seconds
   174                chart_type: line
   175                dimensions:
   176                  - name: a dimension per directory
   177              - name: filecheck.dir_num_of_files
   178                description: Dir Number of Files
   179                unit: files
   180                chart_type: line
   181                dimensions:
   182                  - name: a dimension per directory
   183              - name: filecheck.dir_size
   184                description: Dir Size
   185                unit: bytes
   186                chart_type: line
   187                dimensions:
   188                  - name: a dimension per directory