summaryrefslogtreecommitdiffstats
path: root/collectors/metadata/single-module-template.yaml
blob: 7f0403509319b26419345072083785b57567c7b2 (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
meta:
  plugin_name: ""
  module_name: ""
  alternative_monitored_instances: []
  monitored_instance:
    name: ""
    link: ""
    categories: []
    icon_filename: ""
  related_resources:
    integrations:
      list:
        - plugin_name: ""
          module_name: ""
  info_provided_to_referring_integrations:
    description: ""
  keywords: []
  most_popular: false
overview:
  data_collection:
    metrics_description: ""
    method_description: ""
  supported_platforms:
    include: []
    exclude: []
  multi-instance: true
  additional_permissions:
    description: ""
  default_behavior:
    auto_detection:
      description: ""
    limits:
      description: ""
    performance_impact:
      description: ""
setup:
  prerequisites:
    list:
      - title: ""
        description: ""
  configuration:
    file:
      name: ""
      description: ""
    options:
      description: ""
      folding:
        title: ""
        enabled: true
      list:
        - name: ""
          default_value: ""
          description: ""
          required: false
    examples:
      folding:
        enabled: true
        title: ""
      list:
        - name: ""
          folding:
            enabled: false
          description: ""
          config: ""
troubleshooting:
  problems:
    list:
      - name: ""
        description: ""
alerts:
  - info: ""
    link: ""
    metric: ""
    name: ""
    os: ""
metrics:
  folding:
    enabled: false
    title: ""
  description: ""
  availability:
    - ""
  scopes:
    - name: ""
      description: ""
      labels:
        - name: ""
          description: ""
      metrics:
        - name: ""
          availability:
            - ""
          description: ""
          unit: ""
          chart_type: ""
          dimensions:
            - name: ""