Skip to main content

Flask Extension for using Pyctuator to enable Spring Boot Admin (SBA) to monitor the application, see https://github.com/SolarEdgeTech/pyctuator

Project description

PyPI build

Flask Pyctuator Extension

A Flask extension that uses Pyctuator to enable Spring Boot Admin (SBA) to monitor health, configuration, log-file and resource-usage of a Flask application.

Please see Pyctuator for the complete documentation and note that the some features such as monitoring memory/disk usage require instlaling of additional modules.

Quick Start

  1. Install Flask and the flask-pyctuator extension using your favorite python package manager
  2. Start a local SBA (Spring Boot Admin) server using Dockers:
    docker run --rm -p 8080:8080 --add-host=host.docker.internal:host-gateway michayaak/spring-boot-admin:2.2.3-1
    
  3. Open SBA's main page, http://localhost:8080, in your browser
  4. Run the following Flask application:
    from flask import Flask
    from flask_pyctuator.flask_pyctuator import FlaskPyctuator
    
    app = Flask("Flask App with Pyctuator")
    
    
    @app.route("/")
    def hello():
      return "Hello World!"
    
    
    FlaskPyctuator(
      app,
      pyctuator_endpoint_url="http://host.docker.internal:5000/pyctuator",
    )
    
    app.run(debug=False, port=5000, host="0.0.0.0")
    

See the complete example and project file in the example folder.

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

flask-pyctuator-0.1.1.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

flask_pyctuator-0.1.1-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

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