Merge pull request #2 from mdegat01/readme-changes

Fix typos and document port better

.README.j2

@@ -14,6 +14,22 @@
 ![Project Maintenance][maintenance-shield]
 [![GitHub Activity][commits-shield]][commits]
 
+[Promtail][promtail] is an agent which ships the contents of local logs to a private
+[Loki][loki] instance or [Grafana Cloud][grafana-cloud]. It is usually deployed
+to every machine that has applications needed to be monitored.
+
+⛔ **Known Issue** - This add-on is waiting on upcoming supervisor functionality
+to function, specifically [this PR](https://github.com/home-assistant/supervisor/pull/2722).
+Once that makes its way into the supervisor release I will update the add-on
+to use the new `journald` config. Until then this add-on cannot scrape logs from
+the system journal as promised. If you choose to use it before that you should set
+`skip_default_scrape_config` to `true` and provide a file for `additional_scrape_configs`
+as it will only be able to see log files created by add-ons.
+
+[![Open your Home Assistant instance and show the add add-on repository dialog
+with a specific repository URL pre-filled.][add-repo-shield]][add-repo]
+[![Open your Home Assistant instance and show the dashboard of a Supervisor add-on.][add-addon-shield]][add-addon]
+
 {% set repository = namespace(url='https%3A//github.com/mdegat01/hassio-addons', slug='39bd2704') %}
 {% if channel == "edge" %}
 {% set repository.url = repository.url + '-edge' %}
@@ -38,22 +54,6 @@ If you are more interested in stable releases of these add-ons:
 <https://github.com/mdegat01/hassio-addons>
 
 {% endif %}
-[![Open your Home Assistant instance and show the add add-on repository dialog
-with a specific repository URL pre-filled.][add-repo-shield]][add-repo]
-[![Open your Home Assistant instance and show the dashboard of a Supervisor add-on.][add-addon-shield]][add-addon]
-
-⛔ **Known Issue** - This add-on is waiting on upcoming supervisor functionality
-to function, specifically [this PR](https://github.com/home-assistant/supervisor/pull/2722).
-Once that makes its way into the supervisor release I will update the add-on
-to use the new `journald` config. Until then this add-on cannot scrape logs from
-the system journal as promised. If you choose to use it before that you should set
-`skip_default_scrape_config` to `true` and provide a file for `additional_scrape_configs`
-as it will only be able to see log files created by add-ons.
-
-[Promtail][promtail] is an agent which ships the contents of local logs to a private
-[Loki][loki] instance or [Grafana Cloud][grafana-cloud]. It is usually deployed
-to every machine that has applications needed to be monitored.
-
 ## About
 
 By default this addon version of Promtail will tail logs from the systemd

README.md

@@ -14,9 +14,9 @@
 ![Project Maintenance][maintenance-shield]
 [![GitHub Activity][commits-shield]][commits]
 
-[![Open your Home Assistant instance and show the add add-on repository dialog
-with a specific repository URL pre-filled.][add-repo-shield]][add-repo]
-[![Open your Home Assistant instance and show the dashboard of a Supervisor add-on.][add-addon-shield]][add-addon]
+[Promtail][promtail] is an agent which ships the contents of local logs to a private
+[Loki][loki] instance or [Grafana Cloud][grafana-cloud]. It is usually deployed
+to every machine that has applications needed to be monitored.
 
 ⛔ **Known Issue** - This add-on is waiting on upcoming supervisor functionality
 to function, specifically [this PR](https://github.com/home-assistant/supervisor/pull/2722).
@@ -26,9 +26,9 @@ the system journal as promised. If you choose to use it before that you should s
 `skip_default_scrape_config` to `true` and provide a file for `additional_scrape_configs`
 as it will only be able to see log files created by add-ons.
 
-[Promtail][promtail] is an agent which ships the contents of local logs to a private
-[Loki][loki] instance or [Grafana Cloud][grafana-cloud]. It is usually deployed
-to every machine that has applications needed to be monitored.
+[![Open your Home Assistant instance and show the add add-on repository dialog
+with a specific repository URL pre-filled.][add-repo-shield]][add-repo]
+[![Open your Home Assistant instance and show the dashboard of a Supervisor add-on.][add-addon-shield]][add-addon]
 
 ## About
 

promtail/DOCS.md

@@ -124,12 +124,15 @@ the options available and how to configure them. The documentation also provides
 
 ### Port: `9080/tcp`
 
-Promtail exposes an HTTP server on this port. There's not a lot of documentation
-on what this is used for. From what is there I believe it is primarily used in
-larger scale Kubernetes deployments for things like healthchecks or where you
-potentially have multiple Promtail instances communicating. Most likely you
-should just leave this option disabled but if you know what you're doing you
-can expose this HTTP server on the host.
+Promtail exposes an HTTP server on this port. There's not any obvious section
+in the documentation describing the API it exposesbut there are a few references.
+I believe it's primary use is in larger scale Kubernetes deployments for things
+like healthchecks or multiple Promtail instances communicating. There is also
+a special pipeline stage called [metrics][promtail-doc-metrics] which can be used
+to create metrics exposed directly from promtail via its API.
+
+Most likely you should just leave this option disabled but if you know what you're
+doing you can expose this HTTP server on the host.
 
 ### Option: `log_level`
 
@@ -268,7 +271,8 @@ SOFTWARE.
 [loki-doc]: https://grafana.com/docs/loki/latest/overview/
 [loki-in-grafana]: https://grafana.com/docs/loki/latest/getting-started/grafana/
 [mdegat01]: https://github.com/mdegat01
-[promtail-doc-scrape-configs]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#scrape_configs
 [promtail-doc-examples]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#example-static-config
+[promtil-doc-metrics]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#metrics
+[promtail-doc-scrape-configs]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#scrape_configs
 [releases]: https://github.com/mdegat01/addon-promtail/releases
 [semver]: http://semver.org/spec/v2.0.0