"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/source/configuration/configuring.rst" between
monasca-log-api-2.7.0.tar.gz and monasca-log-api-2.9.0.tar.gz

About: OpenStack Monasca Log API is a RESTful API server acting as gateway for logs collected from log-agents.
The "Stein" series (maintained release).

configuring.rst  (monasca-log-api-2.7.0):configuring.rst  (monasca-log-api-2.9.0)
skipping to change at line 32 skipping to change at line 32
Configuring Keystone Authorization Configuring Keystone Authorization
---------------------------------- ----------------------------------
Keystone authorization (i.e. verification of the token associated Keystone authorization (i.e. verification of the token associated
with a request) is a critical part of monasca-log-api. with a request) is a critical part of monasca-log-api.
It prevents from unauthorized access and provides the isolation It prevents from unauthorized access and provides the isolation
needed for multi-tenancy. needed for multi-tenancy.
The configuration for ``keystonemiddleware`` should either be provided in The configuration for ``keystonemiddleware`` should either be provided in
``log-api.conf`` or in a file in one of the configuration directories. ``monasca-log-api.conf`` or in a file in one of the configuration directories.
For more details about configuration options, check For more details about configuration options, check
`here <https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitectu re.html#configuration>`_. `here <https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitectu re.html#configuration>`_.
Configuring Log Publishing Configuring Log Publishing
-------------------------- --------------------------
monasca-log-api sends all logs to the Kafka Message Queue. monasca-log-api sends all logs to the Kafka Message Queue.
Proper configuration should include: Proper configuration should include:
* ``kafka_url`` - comma-delimited list of Kafka brokers * ``kafka_url`` - comma-delimited list of Kafka brokers
* ``topics`` - names of the topics to which the logs will be pushed to * ``topics`` - names of the topics to which the logs will be pushed to
* ``max_message_size`` - maximum message size that can be posted a topic * ``max_message_size`` - maximum message size that can be posted a topic
The configuration for ``log_publisher`` should either be provided in The configuration for ``log_publisher`` should either be provided in
``log-api.conf`` or in a file in one of the configuration directories. ``monasca-log-api.conf`` or in a file in one of the configuration directories.
Configuring Healthcheck Configuring Healthcheck
----------------------- -----------------------
Healthcheck is an essential part of monasca-log-api. Healthcheck is an essential part of monasca-log-api.
It allows sending HTTP requests and getting knowledge about the It allows sending HTTP requests and getting knowledge about the
availability of the API. Configuration of healthcheck includes: availability of the API. Configuration of healthcheck includes:
* ``kafka_url`` - comma-delimited list of Kafka brokers * ``kafka_url`` - comma-delimited list of Kafka brokers
* ``kafka_topics`` - list of topics that existence is verified by healthcheck * ``kafka_topics`` - list of topics that existence is verified by healthcheck
The configuration for ``kafka_healthcheck`` should either be provided in The configuration for ``kafka_healthcheck`` should either be provided in
``log-api.conf`` or in a file in one of the configuration directories. ``monasca-log-api.conf`` or in a file in one of the configuration directories.
Configuring Monitoring Configuring Monitoring
---------------------- ----------------------
monasca-log-api is capable of self-monitoring. This is achieved monasca-log-api is capable of self-monitoring. This is achieved
through `monasca-statsd <https://github.com/openstack/monasca-statsd>`_. through `monasca-statsd <https://github.com/openstack/monasca-statsd>`_.
It assumes that there is monasca-agent available on the system node and It assumes that there is monasca-agent available on the system node and
that statsd-server has been launched. that statsd-server has been launched.
There are several options you may want to tweak if necessary: There are several options you may want to tweak if necessary:
* ``statsd_host``- the host statsd-server is bound to * ``statsd_host``- the host statsd-server is bound to
* ``statsd_port``- the port statsd-server is bound to * ``statsd_port``- the port statsd-server is bound to
* ``statsd_buffer`` - the amount of metrics to buffer in memory before sending * ``statsd_buffer`` - the amount of metrics to buffer in memory before sending
any any
* ``dimensions`` - additional dimensions to be sent with all * ``dimensions`` - additional dimensions to be sent with all
metrics for this monasca-log-api instance metrics for this monasca-log-api instance
The configuration for ``monitoring`` should either be provided in The configuration for ``monitoring`` should either be provided in
``log-api.conf`` or in a file in one of the configuration directories. ``monasca-log-api.conf`` or in a file in one of the configuration directories.
Configuring RBAC Configuring RBAC
---------------- ----------------
At the moment monasca-log-api does not feature RBAC fully with The role-based access policy can be defined in the ``log-api.policy.yaml`` file
``oslo.policies``. as described in `oslo.policy documentation
It provides a custom mechanism, however, that can be configured as follows: <https://docs.openstack.org/oslo.policy>`_.
Additionally, for historical reasons, custom RBAC mechanism is provided. It can
be configured as follows:
* ``path`` - list of URIs that RBAC applies to * ``path`` - list of URIs that RBAC applies to
* ``default_roles`` - list of roles that are permitted to access the API * ``default_roles`` - list of roles that are permitted to access the API
* ``agent_roles`` - list of roles, that if present, means that requests come * ``agent_roles`` - list of roles, that if present, means that requests come
from log-agent from log-agent
* ``delegate_roles`` - list of roles required by log-agent for sending logs * ``delegate_roles`` - list of roles required by log-agent for sending logs
on behalf of another project (tenant) on behalf of another project (tenant)
The configuration for ``roles_middleware`` should either be provided in The configuration for ``roles_middleware`` can be provided either in
``log-api.conf`` or in a file in one of the configuration directories. ``monasca-log-api.conf`` or in a file in one of the configuration directories.
The configuration for accessing the services by ``oslo.policies`` can be
provided in ``log-api.policy.yaml``.
Configuring Logging Configuring Logging
------------------- -------------------
Logging in monasca-log-api is controlled from the single Logging in monasca-log-api is controlled from the single
``log-api-logging.conf`` configuration file. ``log-api-logging.conf`` configuration file.
Here is a short list of several modifications you may want to apply, Here is a short list of several modifications you may want to apply,
based on your deployment: based on your deployment:
* to log INFO to console:: * to log INFO to console::
skipping to change at line 135 skipping to change at line 135
* if you have an external script for log rotation:: * if you have an external script for log rotation::
[handler_file] [handler_file]
handler = logging.handlers.WatchedFileHandler handler = logging.handlers.WatchedFileHandler
args = ('/var/log/log-api.log', 'a') args = ('/var/log/log-api.log', 'a')
That will store up to 5 rotations (each having maximum size That will store up to 5 rotations (each having maximum size
of 100MBs) of 100MBs)
The configuration of ``logging`` should be presented inside The configuration of ``logging`` should be presented inside
``log-api-logging.conf`` file and referenced from ``log-api.conf`` using ``log-api-logging.conf`` file and referenced from ``monasca-log-api.conf``
``log_config_append`` option. using ``log_config_append`` option.
If you want to know more about possible ways to save monasca-log-api logs, If you want to know more about possible ways to save monasca-log-api logs,
feel free to visit: feel free to visit:
* `oslo.log <https://docs.openstack.org/oslo.log/latest/index.html>`_ * `oslo.log <https://docs.openstack.org/oslo.log/latest/index.html>`_
* `Python HowTo <https://docs.python.org/2/howto/logging.html>`_ * `Python HowTo <https://docs.python.org/2/howto/logging.html>`_
* `Logging handlers <https://docs.python.org/2/library/logging.handlers.html>` _ * `Logging handlers <https://docs.python.org/2/library/logging.handlers.html>` _
Configuring Policies Configuring Policies
-------------------- --------------------
 End of changes. 7 change blocks. 
14 lines changed or deleted 14 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)