summaryrefslogtreecommitdiffstats
path: root/integrations/templates
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-10-17 09:30:23 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-10-17 09:30:23 +0000
commit517a443636daa1e8085cb4e5325524a54e8a8fd7 (patch)
tree5352109cc7cd5122274ab0cfc1f887b685f04edf /integrations/templates
parentReleasing debian version 1.42.4-1. (diff)
downloadnetdata-517a443636daa1e8085cb4e5325524a54e8a8fd7.tar.xz
netdata-517a443636daa1e8085cb4e5325524a54e8a8fd7.zip
Merging upstream version 1.43.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'integrations/templates')
-rw-r--r--integrations/templates/alerts.md2
-rw-r--r--integrations/templates/metrics.md4
-rw-r--r--integrations/templates/overview/collector.md3
-rw-r--r--integrations/templates/platform_info.md4
-rw-r--r--integrations/templates/setup.md2
-rw-r--r--integrations/templates/setup/sample-netdata-config.md8
6 files changed, 14 insertions, 9 deletions
diff --git a/integrations/templates/alerts.md b/integrations/templates/alerts.md
index ca8bd66e6..56f08d4c5 100644
--- a/integrations/templates/alerts.md
+++ b/integrations/templates/alerts.md
@@ -7,7 +7,7 @@ The following alerts are available:
| Alert name | On metric | Description |
|:------------|:----------|:------------|
[% for alert in entry.alerts %]
-| [ [[ alert.name ]] ]([[ alert.link ]]) | [[ alert.metric ]] | [[ alert.info ]] |
+| [ [[ strfy(alert.name) ]] ]([[ strfy(alert.link) ]]) | [[ strfy(alert.metric) ]] | [[ strfy(alert.info) ]] |
[% endfor %]
[% else %]
There are no alerts configured by default for this integration.
diff --git a/integrations/templates/metrics.md b/integrations/templates/metrics.md
index 95fa7504b..d8df98779 100644
--- a/integrations/templates/metrics.md
+++ b/integrations/templates/metrics.md
@@ -21,7 +21,7 @@ Labels:
| Label | Description |
|:-----------|:----------------|
[% for label in scope.labels %]
-| [[ label.name ]] | [[ label.description ]] |
+| [[ strfy(label.name) ]] | [[ strfy(label.description) ]] |
[% endfor %]
[% else %]
This scope has no labels.
@@ -34,7 +34,7 @@ Metrics:
|:------|:----------|:----|[% for a in entry.metrics.availability %]:---:|[% endfor %]
[% for metric in scope.metrics %]
-| [[ metric.name ]] | [% for d in metric.dimensions %][[ d.name ]][% if not loop.last %], [% endif %][% endfor %] | [[ metric.unit ]] |[% for a in entry.metrics.availability %] [% if not metric.availability|length or a in metric.availability %]•[% else %] [% endif %] |[% endfor %]
+| [[ strfy(metric.name) ]] | [% for d in metric.dimensions %][[ strfy(d.name) ]][% if not loop.last %], [% endif %][% endfor %] | [[ strfy(metric.unit) ]] |[% for a in entry.metrics.availability %] [% if not metric.availability|length or a in metric.availability %]•[% else %] [% endif %] |[% endfor %]
[% endfor %]
diff --git a/integrations/templates/overview/collector.md b/integrations/templates/overview/collector.md
index 0030b2533..5442fad4e 100644
--- a/integrations/templates/overview/collector.md
+++ b/integrations/templates/overview/collector.md
@@ -1,5 +1,8 @@
# [[ entry.meta.monitored_instance.name ]]
+Plugin: [[ entry.meta.plugin_name ]]
+Module: [[ entry.meta.module_name ]]
+
## Overview
[[ entry.overview.data_collection.metrics_description ]]
diff --git a/integrations/templates/platform_info.md b/integrations/templates/platform_info.md
index dfa0b1980..7fc0dc790 100644
--- a/integrations/templates/platform_info.md
+++ b/integrations/templates/platform_info.md
@@ -1,5 +1,5 @@
[% if entries %]
-The following releases of this platform are supported:
+We build native packages for the following releases:
| Version | Support Tier | Native Package Architectures | Notes |
|:-------:|:------------:|:----------------------------:|:----- |
@@ -7,3 +7,5 @@ The following releases of this platform are supported:
| [[ e.version ]] | [[ e.support ]] | [[ ', '.join(e.arches) ]] | [[ e.notes ]] |
[% endfor %]
[% endif %]
+
+On other releases of this distribution, a static binary will be installed in `/opt/netdata`.
diff --git a/integrations/templates/setup.md b/integrations/templates/setup.md
index 101f5bcbc..e2318ed85 100644
--- a/integrations/templates/setup.md
+++ b/integrations/templates/setup.md
@@ -65,7 +65,7 @@ There is no configuration file.
| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
[% for item in entry.setup.configuration.options.list %]
-| [[ item.name ]] | [[ item.description ]] | [[ item.default ]] | [[ item.required ]] |
+| [[ strfy(item.name) ]] | [[ strfy(item.description) ]] | [[ strfy(item.default_value) ]] | [[ strfy(item.required) ]] |
[% endfor %]
[% for item in entry.setup.configuration.options.list %]
diff --git a/integrations/templates/setup/sample-netdata-config.md b/integrations/templates/setup/sample-netdata-config.md
index 429f71167..bff5dcfae 100644
--- a/integrations/templates/setup/sample-netdata-config.md
+++ b/integrations/templates/setup/sample-netdata-config.md
@@ -1,10 +1,10 @@
The file format is a modified INI syntax. The general structure is:
-```toml
+```ini
[section1]
- option 1 = some value
- option 2 = some other value
+ option1 = some value
+ option2 = some other value
[section2]
- option 3 = some third value
+ option3 = some third value
```