x/fuel-plugin-lma-collector
Code Issues Proposed changes

Fix links to the Readthedocs domain

Browse Source 
Change-Id: Ibb0e53f7695484f1bb49af9233321110bb934982
This commit is contained in:
Simon Pasquier
2016-05-20 11:33:17 +02:00
parent 56ef5c42f4
commit 85399b5d23
9 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/dev/source/common_message_format.rst
View File

@@ -50,4 +50,4 @@ Attributes in **bold** are always present in the messages while attributes in
.. note:: All date/time fields represented as string are formatted according
to the `RFC3339 <http://tools.ietf.org/html/rfc3339>`_ document.
.. [#] `Heka message structure <http://hekad.readthedocs.org/en/latest/message/index.html>`_
.. [#] `Heka message structure <http://hekad.readthedocs.io/en/latest/message/index.html>`_

2
doc/dev/source/metrics.rst
View File

@@ -76,4 +76,4 @@ Attributes in **bold** are always present in the messages while attributes in
Metric messages may include additional fields to specify the scope of the
measurement. Refer to the `User Documentation`_ for more details.
.. _User Documentation: http://fuel-plugin-lma-collector.readthedocs.org/en/latest/user/appendix_b.html
.. _User Documentation: http://fuel-plugin-lma-collector.readthedocs.io/en/latest/user/appendix_b.html

6
doc/dev/source/overview.rst
View File

@@ -28,7 +28,7 @@ Its core components are :
The primary function of the Collector is to transform the acquired raw
operational data into an internal message representation that is based on the
`Heka message structure <http://hekad.readthedocs.org/en/latest/message/index.html>`_.
`Heka message structure <http://hekad.readthedocs.io/en/latest/message/index.html>`_.
that can be further exploited to, for example, detect anomalies or create
new metric messages.
@@ -54,13 +54,13 @@ Furthermore, the LMA Toolchain has been designed with the dual objective to be b
It is, for example, quite possible (without any code change) to integrate the Collector
with an external monitoring application like Nagios. This could simply be done through enabling
the Nagios output plugin of Heka for a subset of messages matching the
`message matcher <https://hekad.readthedocs.org/en/latest/message_matcher.html#message-matcher>`_
`message matcher <https://hekad.readthedocs.io/en/latest/message_matcher.html#message-matcher>`_
syntax of the output plugin. You should probably not modify the configuration of the LMA
Collector manually but apply any configuration change to the Puppet manifests that are shipped
with the LMA Collector plugin for Fuel. Many other integration combinations are possible thanks
to the extreme flexibility of Heka.
We recommend you to read the Heka `documentation <https://hekad.readthedocs.org/en/latest/index.html>`_
We recommend you to read the Heka `documentation <https://hekad.readthedocs.io/en/latest/index.html>`_
to become more familiar with that technology.
The rest of this document is organised in several chapters that will take you through a

8
doc/qa/source/appendix.rst
View File

@@ -3,10 +3,10 @@
Appendix
========
* The `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.org/>`_.
* The `LMA Infrastructure Alerting documentation <http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/>`_.
* The `Elasticsearch-Kibana documentation <http://fuel-plugin-elasticsearch-kibana.readthedocs.org/>`_.
* The `InfluxDB-Grafana documentation <http://fuel-plugin-influxdb-grafana.readthedocs.org/>`_.
* The `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.io/>`_.
* The `LMA Infrastructure Alerting documentation <http://fuel-plugin-lma-infrastructure-alerting.readthedocs.io/>`_.
* The `Elasticsearch-Kibana documentation <http://fuel-plugin-elasticsearch-kibana.readthedocs.io/>`_.
* The `InfluxDB-Grafana documentation <http://fuel-plugin-influxdb-grafana.readthedocs.io/>`_.
* The official `Kibana documentation <https://www.elastic.co/guide/en/kibana/3.0/index.html>`_.
* The official `Grafana documentation <http://docs.grafana.org/>`_.
* The official `Nagios documentation <https://www.nagios.org/documentation/>`_.

2
doc/qa/source/tests/deploy.rst
View File

@@ -66,7 +66,7 @@ Steps
#. Once the deployment has finished, connect to each node of the environment using ssh and run the following checks:
a. Check that hekad and collectd processes are up and running on all the nodes as described in the `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.org/en/stable/user/configuration.html#plugin-verification>`_.
a. Check that hekad and collectd processes are up and running on all the nodes as described in the `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.io/en/stable/user/configuration.html#plugin-verification>`_.
#. Look for errors in /var/log/lma_collector.log

2
doc/qa/source/tests/deploy_ha_mode.rst
View File

@@ -66,7 +66,7 @@ Steps
#. Once the deployment has finished, connect to each node of the environment using ssh and run the following checks:
a. Check that hekad and collectd processes are up and running on all the nodes as described in the `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.org/en/stable/user/configuration.html#plugin-verification>`_.
a. Check that hekad and collectd processes are up and running on all the nodes as described in the `LMA Collector documentation <http://fuel-plugin-lma-collector.readthedocs.io/en/stable/user/configuration.html#plugin-verification>`_.
#. Run 'pcs resource' on one of nodes with plugin roles and check that all services are started.

2
doc/user/source/alarms.rst
View File

@@ -102,7 +102,7 @@ The *AFD metrics* and *GSE metrics* are new types of metrics introduced
in LMA v 0.8. They contain detailed information about the entities
being monitored.
Please refer to the `Metrics section of the Developer Guide
<http://fuel-plugin-lma-collector.readthedocs.org/en/latest/appendix_b.html>`_
<http://fuel-plugin-lma-collector.readthedocs.io/en/latest/appendix_b.html>`_
for further information about the structure of those messages.
Any backend system that has a *Persister* plugged

6
doc/user/source/installation.rst
View File

@@ -14,9 +14,9 @@ There are two options:
1. Install these backend services automatically using the Fuel Plugins listed below.
* `Elasticsearch-Kibana Fuel Plugin Installation Guide <http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/installation.html#installation-guide>`_.
* `InfluxDB-Grafana Fuel Plugin Installation Guide <http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/installation.html#installation-guide>`_.
* `Infrastructure Alerting Fuel Plugin Installation Guide <http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/installation.html#installation-guide>`_.
* `Elasticsearch-Kibana Fuel Plugin Installation Guide <http://fuel-plugin-elasticsearch-kibana.readthedocs.io/en/latest/installation.html#installation-guide>`_.
* `InfluxDB-Grafana Fuel Plugin Installation Guide <http://fuel-plugin-influxdb-grafana.readthedocs.io/en/latest/installation.html#installation-guide>`_.
* `Infrastructure Alerting Fuel Plugin Installation Guide <http://fuel-plugin-lma-infrastructure-alerting.readthedocs.io/en/latest/installation.html#installation-guide>`_.
2. Install these backend services manually outside of your OpenStack environment.
This installation must comply with the LMA Collector Plugin's :ref:`requirements <plugin_requirements>`.

2
doc/user/source/overview.rst
View File

@@ -28,7 +28,7 @@ log files, collectd and RabbitMQ for the OpenStack notifications.
A primary function of the Collector is to sanitise and transform the ingested
raw operational data into internal messages using the
`Heka message structure <https://hekad.readthedocs.org/en/stable/message/index.html>`_.
`Heka message structure <https://hekad.readthedocs.io/en/stable/message/index.html>`_.
This message structure is used within the Collector's framework to match, filter
and route messages to plugins written in
`Lua <http://www.lua.org/>`_ which perform various