Skip to main content

OpenStack Monitoring as a Service

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/monasca-api.svg

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monasca-api-11.0.0.tar.gz (548.4 kB view details)

Uploaded Source

Built Distribution

monasca_api-11.0.0-py3-none-any.whl (246.3 kB view details)

Uploaded Python 3

File details

Details for the file monasca-api-11.0.0.tar.gz.

File metadata

  • Download URL: monasca-api-11.0.0.tar.gz
  • Upload date:
  • Size: 548.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for monasca-api-11.0.0.tar.gz
Algorithm Hash digest
SHA256 e5071f7392aa9fad6d4f5dd9add5b0e09cb663a63532e1effa783107d29690f3
MD5 6810a24e1d1391c0144667dcbc50fa56
BLAKE2b-256 aa72ae07741bae1cb49e7b317129c23dc82a9cd5fc3e9b88cde58643639db686

See more details on using hashes here.

File details

Details for the file monasca_api-11.0.0-py3-none-any.whl.

File metadata

  • Download URL: monasca_api-11.0.0-py3-none-any.whl
  • Upload date:
  • Size: 246.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for monasca_api-11.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f9bd1ced28ad7cfba02d993bf9575fda3c7ae07393469da396264e8be0231d4
MD5 de0dc74b2d7c145b64cef232ea16e3c7
BLAKE2b-256 b0307d0be3418f0b855834710d155e6b1122c15f0a4bce107cf56094f23fd63a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page