Monasca REST API
Go to file
Hasan Acar a24fd834d0 fix: migrate CI to jammy
fix: change tox.ini

fix: change queries for list_dimension_names and list_dimension_values because of influxdb time filter problem

fix: remove build_sphinx group from setup.cfg

fix: handle hashlib security problem

Change-Id: I0d31a8db5ed71c70e7b878ce5e7940e041d0fa43

Change-Id: I6f7066da10e834550cbf0c053c7bf425ac0ead93

Change-Id: If9575aee73d600bbc84fcdf58deb1c57b508d9c2

Change-Id: If515eaeee7539da3ca49997e88785dc65572b334
2024-02-22 14:35:03 +00:00
api-ref Switch to newer openstackdocstheme and reno versions 2020-05-21 17:14:23 +02:00
common Restore user condition but with zuul 2017-10-19 06:08:28 +02:00
config-generator Add keystonemiddleware to oslo-config-generator conf 2019-01-28 16:11:51 +01:00
contrib Remove bundled intree monasca-api tempest plugin 2018-01-31 11:50:16 +05:30
devstack fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
doc fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
docker fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
docs Allow users to set periodic notifications on all notification types 2020-01-21 10:49:22 +00:00
etc Update devstack plugin to support new api 2019-12-04 13:52:57 +01:00
java [Trivial Fix] change the unicode of some higher numbered characters 2018-09-07 08:44:04 +08:00
monasca_api fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
perf Add read performance testing to monasca-api 2018-01-25 08:18:13 -08:00
playbooks Fix zuul publish docker image job 2022-02-02 20:11:40 +01:00
releasenotes fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
tools Avoid tox_install.sh for constraints support 2017-12-01 15:37:36 +01:00
.coveragerc Migrate test run to ostestr 2017-01-14 19:47:29 +00:00
.gitignore Merge log-api and api 2019-09-26 12:02:20 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:15 +00:00
.stestr.conf Add .stestr.conf . 2017-09-22 13:41:11 +02:00
.zuul.yaml Update invalid zuul syntax 2023-06-01 17:57:49 +02:00
CONTRIBUTING.rst Update Monasca contribution documentation 2020-05-19 16:51:08 +02:00
LICENSE Added license file 2014-05-01 16:22:11 -07:00
README.rst [ussuri][goal] Drop python 2.7 support and testing 2019-12-10 13:58:58 +01:00
babel.cfg initial python implementation 2014-09-15 13:18:10 -04:00
bindep.txt Add libssl to fix pep8 2017-06-07 15:54:02 -06:00
pom.xml Update links in pom.xml 2018-01-12 16:27:30 +08:00
requirements.txt Drop lower-constraints.txt and its testing 2022-04-30 19:22:11 -05:00
run_maven.sh Ensure the same branch is used for common build 2016-02-10 09:11:02 -07:00
setup.cfg fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
setup.py Cleanup py27 support 2020-04-05 11:35:05 +02:00
test-requirements.txt fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00
tox.ini fix: migrate CI to jammy 2024-02-22 14:35:03 +00:00

README.rst

Team and repository tags

image

Overview

monasca-api is a RESTful API server that is designed with a layered architecture.

Documentation

The full API Specification can be found in docs/monasca-api-spec.md

Python Monasca API Implementation

To install the python api implementation, git clone the source and run the following command:

$ sudo python setup.py install

If it installs successfully, you will need to make changes to the following two files to reflect your system settings, especially where kafka server is located:

/etc/monasca/api-config.ini
/etc/monasca/monasca-api.conf
/etc/monasca/api-logging.conf

Once the configuration files are modified to match your environment, you can start up the server by following the following instructions.

To start the server, run the following command:

Running the server in foreground mode
$ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini

Running the server as daemons
$ gunicorn -k eventlet --worker-connections=2000 --backlog=1000 --paste /etc/monasca/api-config.ini -D

To check if the code follows python coding style, run the following command from the root directory of this project

$ tox -e pep8

To run all the unit test cases, run the following command from the root directory of this project

$ tox -e py36

Start the Server - for Apache

To start the server using Apache: create a modwsgi file, create a modwsgi configuration file, and enable the wsgi module in Apache.

The modwsgi configuration file may look something like this, and the site will need to be enabled:

Listen 8070

<VirtualHost *:8070>

    WSGIDaemonProcess monasca-api processes=4 threads=1 socket-timeout=120 user=mon-api group=monasca python-path=/usr/local/lib/python2.7/site-packages
    WSGIProcessGroup monasca-api
    WSGIApplicationGroup monasca-api
    WSGIScriptAlias / /usr/local/lib/python2.7/site-packages/monasca_api/api/wsgi/monasca_api.py

    WSGIPassAuthorization On

    LogLevel info
    ErrorLog /var/log/monasca-api/wsgi.log
    CustomLog /var/log/monasca-api/wsgi-access.log combined

    <Directory /usr/local/lib/python2.7/site-packages/monasca_api>
      Require all granted
    </Directory>

    SetEnv no-gzip 1

</VirtualHost>

The wsgi file may look something like this:

from monasca_api.api import server

application = server.get_wsgi_app(config_base_path='/etc/monasca')

Java Implementation

Details on usage can be found here

WARNING: The Java implementation of Monasca API is DEPRECATED and will be removed in future release.

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.