Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 2.99 KB

README_ES.md

File metadata and controls

102 lines (65 loc) · 2.99 KB
Raw

In English

FlaskStatus

Es una extensión de Flask para visualizar incidentes provocados por el servidor.

Example Status

Esto se maneja en función de las solicitudes que realizan los usuarios. Captura la respuesta del servidor y utiliza la expresión condicional para clasificar rápidamente si la solicitud fue exitosa o si ha fallado.

Nota: Actualizaciones cada minuto

Codes HTTP

Algunos de los estados de HTTP que el servidor toma en cuenta son:

  • 200 OK: Indica que la solicitud ha sido completada con éxito.

  • 404 Not Found: Indica que el recurso solicitado no se encuentra disponible en el servidor.

  • 500 Internal Server Error: Indica que ha ocurrido un error interno en el servidor al procesar la solicitud del cliente.

  • 502 Bad Gateway: Indica que existe un error de comunicación entre servidores, generalmente cuando un servidor actúa como intermediario y no puede obtener una respuesta válida.

  • 503 Service Unavailable: Indica que el servidor no está disponible en ese momento, posiblemente debido a mantenimiento o sobrecarga.

  • 504 Gateway Timeout: Indica que el servidor no ha recibido una respuesta a tiempo de un servidor upstream, lo que puede indicar problemas de conectividad.

Instalar

pip install flask-server-status

Uso

  • Importar y configurar FlaskStatus en tu aplicación Flask. Necesita una base de datos para registrar los registros.
from flask import Flask
from flask_server_status import FlaskStatus

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///tmp/status.db'
FlaskStatus(app)

Puedes configurar qué rutas quieres que se muestren:

FlaskStatus(app, routes=['/'])

La ruta por defecto es: /status. Aunque puedes configurar la ruta.

FlaskStatus(app, url_prefix='/status')
  • Definir rutas. El uso de docstring. Se utilizará para definir el nombre de la ruta. # <NOMBRE DE LA RUTA>
@app.route('/')
def index():
    """
    # Index
    """ # This is the docstring
    return 'Welcome to API!', 200 # 200 is the status code

En caso de que no hayas definido el nombre de la ruta. De forma predeterminada, tomará el nombre de la función del endpoint.

API

FlaskStatus viene con una API incorporada para configurar las rutas que se generan en la base de datos.

app.config['API_ENABLED'] = True
app.config['API_SECRET'] = 'tSx0L5exSjiPqqXs'

Endpoints

  • PUT /flask-status/configure: Le permite modificar una ruta. json={'rule': '/', 'name': 'Hello World!', 'doc': ''}

  • DELETE /flask-status/configure: Le permite eliminar una ruta. json={'rule': '/'}

Ejemplo

import requests

r = requests.delete('http://127.0.0.1:5000/flask-status/configure', headers={
    'Authorization': 'Bearer tSx0L5exSjiPqqXs'
    }, json={
    'rule': '/'
})

Forked from

La página fue construida por Statsig's Open-Source Status Page.