master
md 70 lines 2.16 KB
Rendered Raw
1 # [[ entry.meta.monitored_instance.name ]]
2
3 Plugin: [[ entry.meta.plugin_name ]]
4 Module: [[ entry.meta.module_name ]]
5
6 ## Overview
7
8 [[ entry.overview.data_collection.metrics_description ]]
9
10 [[ entry.overview.data_collection.method_description ]]
11
12 [% if entry.overview.supported_platforms.include %]
13 This collector is only supported on the following platforms:
14
15 [% for platform in entry.overview.supported_platforms.include %]
16 - [[ platform ]]
17 [% endfor %]
18 [% elif entry.overview.supported_platforms.exclude %]
19 This collector is supported on all platforms except for the following platforms:
20
21 [% for platform in entry.overview.supported_platforms.exclude %]
22 - [[ platform ]]
23 [% endfor %]
24 [% else %]
25 This collector is supported on all platforms.
26 [% endif %]
27
28 [% if entry.overview.multi_instance %]
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30 [% else %]
31 This collector only supports collecting metrics from a single instance of this integration.
32 [% endif %]
33
34 [% if entry.overview.additional_permissions.description %]
35 [[ entry.overview.additional_permissions.description ]]
36 [% endif %]
37
38 [% if related %]
39 [[ entry.meta.monitored_instance.name ]] can be monitored further using the following other integrations:
40
41 [% for res in related %]
42 - {% relatedResource id="[[ res.id ]]" %}[[ res.name ]]{% /relatedResource %}
43 [% endfor %]
44
45 [% endif %]
46 ### Default Behavior
47
48 #### Auto-Detection
49
50 [% if entry.overview.default_behavior.auto_detection.description %]
51 [[ entry.overview.default_behavior.auto_detection.description ]]
52 [% else %]
53 This integration doesn't support auto-detection.
54 [% endif %]
55
56 #### Limits
57
58 [% if entry.overview.default_behavior.limits.description %]
59 [[ entry.overview.default_behavior.limits.description ]]
60 [% else %]
61 The default configuration for this integration does not impose any limits on data collection.
62 [% endif %]
63
64 #### Performance Impact
65
66 [% if entry.overview.default_behavior.performance_impact.description %]
67 [[ entry.overview.default_behavior.performance_impact.description ]]
68 [% else %]
69 The default configuration for this integration is not expected to impose a significant performance impact on the system.
70 [% endif %]