README: update the configuration for the exporter plus add note

mtds · mtds · commit cc2b9e2ee969 · 2018-11-08T14:20:51.000+01:00
diff --git a/README.md b/README.md
@@ -113,6 +113,8 @@ make build
 It is strongly advisable to configure the Prometheus server with the following parameters:
 
 ```
+scrape_configs:
+
 #
 # SLURM resource manager:
 # 
@@ -129,6 +131,8 @@ It is strongly advisable to configure the Prometheus server with the following p
 * **scrape_interval**: a 30 seconds interval will avoid possible 'overloading' on the SLURM master due to frequent calls of sdiag/squeue/sinfo commands through the exporter.
 * **scrape_timeout**: on a busy SLURM master a too short scraping timeout will abort the communication from the Prometheus server toward the exporter, thus generating a ``context_deadline_exceeded`` error.
 
+The previous configuration file can be immediately used with a fresh installation of Promethues. At the same time, we highly recommend to include at least the ``global`` section into the configuration. Official documentation about __configuring Prometheus__ is [available here](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).
+
 **NOTE**: the Prometheus server is using __YAML__ as format for its configuration file, thus **indentation** is really important. Before reloading the Prometheus server it would be better to check the syntax:
 
 ```

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,8 @@ make build`
`113`	`113`	`It is strongly advisable to configure the Prometheus server with the following parameters:`
`114`	`114`
`115`	`115`	```
	`116`	`+scrape_configs:`
	`117`	`+`
`116`	`118`	`#`
`117`	`119`	`# SLURM resource manager:`
`118`	`120`	`#`
`@@ -129,6 +131,8 @@ It is strongly advisable to configure the Prometheus server with the following p`
`129`	`131`	`* scrape_interval: a 30 seconds interval will avoid possible 'overloading' on the SLURM master due to frequent calls of sdiag/squeue/sinfo commands through the exporter.`
`130`	`132`	* scrape_timeout: on a busy SLURM master a too short scraping timeout will abort the communication from the Prometheus server toward the exporter, thus generating a ``context_deadline_exceeded`` error.
`131`	`133`
	`134`	+The previous configuration file can be immediately used with a fresh installation of Promethues. At the same time, we highly recommend to include at least the ``global`` section into the configuration. Official documentation about __configuring Prometheus__ is [available here](https://prometheus.io/docs/prometheus/latest/configuration/configuration/).
	`135`	`+`
`132`	`136`	`NOTE: the Prometheus server is using __YAML__ as format for its configuration file, thus indentation is really important. Before reloading the Prometheus server it would be better to check the syntax:`
`133`	`137`
`134`	`138`	```