summaryrefslogtreecommitdiffstats
path: root/integrations/templates/overview/collector.md
blob: 0030b2533fba57dcedbdb97887020910dd372766 (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
# [[ entry.meta.monitored_instance.name ]]

## Overview

[[ entry.overview.data_collection.metrics_description ]]

[[ entry.overview.data_collection.method_description ]]

[% if entry.overview.supported_platforms.include %]
This collector is only supported on the following platforms:

[% for platform in entry.overview.supported_platforms.include %]
- [[ platform ]]
[% endfor %]
[% elif entry.overview.supported_platforms.exclude %]
This collector is supported on all platforms except for the following platforms:

[% for platform in entry.overview.supported_platforms.exclude %]
- [[ platform ]]
[% endfor %]
[% else %]
This collector is supported on all platforms.
[% endif %]

[% if entry.overview.multi_instance %]
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
[% else %]
This collector only supports collecting metrics from a single instance of this integration.
[% endif %]

[% if entry.overview.additional_permissions.description %]
[[ entry.overview.additional_permissions.description ]]
[% endif %]

[% if related %]
[[ entry.meta.name ]] can be monitored further using the following other integrations:

[% for res in related %]
- {% relatedResource id="[[ res.id ]]" %}[[ res.name ]]{% /relatedResource %}
[% endfor %]

[% endif %]
### Default Behavior

#### Auto-Detection

[% if entry.overview.default_behavior.auto_detection.description %]
[[ entry.overview.default_behavior.auto_detection.description ]]
[% else %]
This integration doesn't support auto-detection.
[% endif %]

#### Limits

[% if entry.overview.default_behavior.limits.description %]
[[ entry.overview.default_behavior.limits.description ]]
[% else %]
The default configuration for this integration does not impose any limits on data collection.
[% endif %]

#### Performance Impact

[% if entry.overview.default_behavior.performance_impact.description %]
[[ entry.overview.default_behavior.performance_impact.description ]]
[% else %]
The default configuration for this integration is not expected to impose a significant performance impact on the system.
[% endif %]