Monasca Database Persister
Go to file
Joseph Davis c32885aed8 Clarify dependency on cachetools in recreate-metric-id tool
It was found in some installations that python-cachetools needed
to be present on the system.  This can happen if the installation
was configured for the Java mon-persister but the recreate-metric-id
tool is written in Python.  Added a bullet item to describe this
dependency and the quick workaround of installing the
python-cachetools package.

Change-Id: I25635c069a5ed21342780a28b516c74b61dae30b
Story: 2005305
Task: 30611
2019-06-06 13:39:54 -07:00
common Replace git.openstack.org URLs with opendev.org URLs 2019-06-03 15:33:15 +02:00
config-generator Update documentation to use new default config 2019-02-18 18:21:25 +01:00
docker Replace git.openstack.org URLs with opendev.org URLs 2019-06-03 15:33:15 +02:00
etc/monasca Turn logging down from DEBUG in persister-logging.conf 2018-09-28 16:26:36 -07:00
java Disable ClassPathURLCheck for Java build 2018-11-06 14:43:01 +01:00
monasca_persister Clarify dependency on cachetools in recreate-metric-id tool 2019-06-06 13:39:54 -07:00
perf Fix the misspelling of "available" 2019-01-22 13:32:21 +08:00
playbooks Push Docker image to Docker Hub 2019-04-15 15:04:28 +02:00
releasenotes Update master for stable/stein 2019-04-01 12:53:24 +00:00
.coveragerc Add coverage report display 2019-04-05 13:33:43 +02:00
.gitignore Add job for releasenotes 2019-02-19 10:46:25 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:25 +00:00
.stestr.conf Add .stestr.conf . 2017-09-22 14:13:18 +02:00
.testr.conf Add persister.py unit tests 2017-01-12 09:18:29 +00:00
.zuul.yaml Merge "Push Docker image to Docker Hub" 2019-04-17 14:05:38 +00:00
LICENSE Added copyright header and LICENSE file. 2014-05-01 12:45:08 -06:00
README.rst README.rst: make it us-ascii 2019-03-19 11:39:00 +01:00
bindep.txt Add bindep.txt 2017-04-12 18:10:55 +02:00
lower-constraints.txt Add job for releasenotes 2019-02-19 10:46:25 +00:00
pom.xml Upper pom version to 1.3.0 2017-12-19 13:11:41 -08:00
requirements.txt Updated from global requirements 2018-03-14 05:38:23 +00:00
run_maven.sh Ensure the same branch is used for common build 2016-02-10 15:30:38 -07:00
setup.cfg Add job for releasenotes 2019-02-19 10:46:25 +00:00
setup.py Updated from global requirements 2017-03-13 19:34:04 +00:00
test-requirements.txt Update hacking version to latest 2019-02-19 14:33:05 +01:00
tox.ini Replace git.openstack.org URLs with opendev.org URLs 2019-06-03 15:33:15 +02:00

README.rst

Team and repository tags

image

monasca-persister

The Monitoring Persister consumes metrics and alarm state transitions from the Message Queue and stores them in the Metrics and Alarms database.

Although the Persister isn't primarily a Web service it uses DropWizard, https://dropwizard.github.io/dropwizard/, which provides a nice Web application framework to expose an http endpoint that provides an interface through which metrics about the Persister can be queried as well as health status.

The basic design of the Persister is to have one Kafka consumer publish to a Disruptor, https://github.com/LMAX-Exchange/disruptor, that has output processors. The output processors use prepared batch statements to write to the Metrics and Alarms database.

The number of output processors/threads in the Persister can be specified to scale to more messages. To horizontally scale and provide fault-tolerance any number of Persisters can be started as consumers from the Message Queue.

Build

Requires monasca-common from https://github.com/openstack/monasca-common. Download and build following instructions in its README.md. Then build monasca-persister by:

mvn clean package

Configuration

A sample configuration file is available in java/src/deb/etc/persister-config.yml-sample.

A second configuration file is provided in java/src/main/resources/persister-config.yml for use with the vagrant "mini-mon" development environment.

TODO

  • Purge metrics on shutdown
  • Add more robust offset management in Kafka. Currently, the offset is advanced as each message is read. If the Persister stops after the metric has been read and prior to it being committed to the Metrics and Alarms database, the metric will be lost.
  • Add better handling of SQL exceptions.
  • Complete health check.
  • Specify and document the names of the metrics that are available for monitoring of the Persister.
  • Document the yaml configuration parameters.

License

Copyright (c) 2014 Hewlett-Packard Development Company, L.P.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Python

To install the Python monasca-persister modules, git clone the source and run the following command:

$ sudo python setup.py install

To run the unit tests use:

$ tox -e py27,py35