alerta_alerta/alerta/views/alerts.py

708 lines
22 KiB
Python

from datetime import datetime
from flask import current_app, g, jsonify, request
from flask_cors import cross_origin
from alerta.app import qb
from alerta.auth.decorators import permission
from alerta.exceptions import (AlertaException, ApiError, BlackoutPeriod,
ForwardingLoop, HeartbeatReceived,
InvalidAction, RateLimit, RejectException)
from alerta.models.alert import Alert
from alerta.models.enums import Scope
from alerta.models.metrics import Timer, timer
from alerta.models.note import Note
from alerta.models.switch import Switch
from alerta.utils.api import (assign_customer, process_action, process_alert,
process_delete, process_note, process_status)
from alerta.utils.audit import write_audit_trail
from alerta.utils.paging import Page
from alerta.utils.response import absolute_url, jsonp
from . import api
receive_timer = Timer('alerts', 'received', 'Received alerts', 'Total time and number of received alerts')
gets_timer = Timer('alerts', 'queries', 'Alert queries', 'Total time and number of alert queries')
status_timer = Timer('alerts', 'status', 'Alert status change', 'Total time and number of alerts with status changed')
tag_timer = Timer('alerts', 'tagged', 'Tagging alerts', 'Total time to tag number of alerts')
untag_timer = Timer('alerts', 'untagged', 'Removing tags from alerts', 'Total time to un-tag and number of alerts')
attrs_timer = Timer('alerts', 'attributes', 'Alert attributes change',
'Total time and number of alerts with attributes changed')
delete_timer = Timer('alerts', 'deleted', 'Deleted alerts', 'Total time and number of deleted alerts')
count_timer = Timer('alerts', 'counts', 'Count alerts', 'Total time and number of count queries')
@api.route('/alert', methods=['OPTIONS', 'POST'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(receive_timer)
@jsonp
def receive():
try:
alert = Alert.parse(request.json)
except ValueError as e:
raise ApiError(str(e), 400)
alert.customer = assign_customer(wanted=alert.customer)
def audit_trail_alert(event: str):
write_audit_trail.send(current_app._get_current_object(), event=event, message=alert.text, user=g.login, # type: ignore
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
try:
alert = process_alert(alert)
except RejectException as e:
audit_trail_alert(event='alert-rejected')
raise ApiError(str(e), 403)
except RateLimit as e:
audit_trail_alert(event='alert-rate-limited')
return jsonify(status='error', message=str(e), id=alert.id), 429
except HeartbeatReceived as heartbeat:
audit_trail_alert(event='alert-heartbeat')
return jsonify(status='ok', message=str(heartbeat), id=heartbeat.id), 202
except BlackoutPeriod as e:
audit_trail_alert(event='alert-blackout')
return jsonify(status='ok', message=str(e), id=alert.id), 202
except ForwardingLoop as e:
return jsonify(status='ok', message=str(e)), 202
except AlertaException as e:
raise ApiError(e.message, code=e.code, errors=e.errors)
except Exception as e:
raise ApiError(str(e), 500)
write_audit_trail.send(current_app._get_current_object(), event='alert-received', message=alert.text, user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert:
return jsonify(status='ok', id=alert.id, alert=alert.serialize), 201
else:
raise ApiError('insert or update of received alert failed', 500)
@api.route('/alert/<alert_id>', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def get_alert(alert_id):
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if alert:
return jsonify(status='ok', total=1, alert=alert.serialize)
else:
raise ApiError('not found', 404)
# set status
@api.route('/alert/<alert_id>/status', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(status_timer)
@jsonp
def set_status(alert_id):
status = request.json.get('status', None)
text = request.json.get('text', '')
timeout = request.json.get('timeout', None)
if not status:
raise ApiError("must supply 'status' as json data", 400)
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
try:
alert, status, text = process_status(alert, status, text)
alert = alert.from_status(status, text, timeout)
except RejectException as e:
write_audit_trail.send(current_app._get_current_object(), event='alert-status-rejected', message=alert.text,
user=g.login, customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert',
request=request)
raise ApiError(str(e), 400)
except AlertaException as e:
raise ApiError(e.message, code=e.code, errors=e.errors)
except Exception as e:
raise ApiError(str(e), 500)
write_audit_trail.send(current_app._get_current_object(), event='alert-status-changed', message=text, user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert:
return jsonify(status='ok')
else:
raise ApiError('failed to set status', 500)
# action alert
@api.route('/alert/<alert_id>/action', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(status_timer)
@jsonp
def action_alert(alert_id):
action = request.json.get('action', None)
text = request.json.get('text', f'{action} operator action')
timeout = request.json.get('timeout', None)
if not action:
raise ApiError("must supply 'action' as json data", 400)
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
try:
# pre action
alert, action, text, timeout = process_action(alert, action, text, timeout)
# update status
alert = alert.from_action(action, text, timeout)
# post action
alert, action, text, timeout = process_action(alert, action, text, timeout, post_action=True)
except RejectException as e:
write_audit_trail.send(current_app._get_current_object(), event='alert-action-rejected', message=alert.text,
user=g.login, customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert',
request=request)
raise ApiError(str(e), 400)
except InvalidAction as e:
raise ApiError(str(e), 409)
except ForwardingLoop as e:
return jsonify(status='ok', message=str(e)), 202
except AlertaException as e:
raise ApiError(e.message, code=e.code, errors=e.errors)
except Exception as e:
raise ApiError(str(e), 500)
write_audit_trail.send(current_app._get_current_object(), event='alert-actioned', message=text, user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert:
return jsonify(status='ok')
else:
raise ApiError('failed to action alert', 500)
# tag
@api.route('/alert/<alert_id>/tag', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(tag_timer)
@jsonp
def tag_alert(alert_id):
tags = request.json.get('tags', None)
if not tags:
raise ApiError("must supply 'tags' as json list")
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
write_audit_trail.send(current_app._get_current_object(), event='alert-tagged', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert.tag(tags):
return jsonify(status='ok')
else:
raise ApiError('failed to tag alert', 500)
# untag
@api.route('/alert/<alert_id>/untag', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(untag_timer)
@jsonp
def untag_alert(alert_id):
tags = request.json.get('tags', None)
if not tags:
raise ApiError("must supply 'tags' as json list")
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
write_audit_trail.send(current_app._get_current_object(), event='alert-untagged', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert.untag(tags):
return jsonify(status='ok')
else:
raise ApiError('failed to untag alert', 500)
# update attributes
@api.route('/alert/<alert_id>/attributes', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@timer(attrs_timer)
@jsonp
def update_attributes(alert_id):
attributes = request.json.get('attributes', None)
if not attributes:
raise ApiError("must supply 'attributes' as json data", 400)
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
write_audit_trail.send(current_app._get_current_object(), event='alert-attributes-updated', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if alert.update_attributes(attributes):
return jsonify(status='ok')
else:
raise ApiError('failed to update attributes', 500)
# delete
@api.route('/alert/<alert_id>', methods=['OPTIONS', 'DELETE'])
@cross_origin()
@permission(Scope.delete_alerts)
@timer(delete_timer)
@jsonp
def delete_alert(alert_id):
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
try:
deleted = process_delete(alert)
except RejectException as e:
write_audit_trail.send(current_app._get_current_object(), event='alert-delete-rejected', message=alert.text,
user=g.login, customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert',
request=request)
raise ApiError(str(e), 400)
except AlertaException as e:
raise ApiError(e.message, code=e.code, errors=e.errors)
except Exception as e:
raise ApiError(str(e), 500)
write_audit_trail.send(current_app._get_current_object(), event='alert-deleted', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=alert.id, type='alert', request=request)
if deleted:
return jsonify(status='ok')
else:
raise ApiError('failed to delete alert', 500)
@api.route('/alerts', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def search_alerts():
query_time = datetime.utcnow()
query = qb.alerts.from_params(request.args, customers=g.customers, query_time=query_time)
show_raw_data = request.args.get('show-raw-data', default=False, type=lambda x: x.lower() in ['true', 't', '1', 'yes', 'y', 'on'])
show_history = request.args.get('show-history', default=False, type=lambda x: x.lower() in ['true', 't', '1', 'yes', 'y', 'on'])
severity_count = Alert.get_counts_by_severity(query)
status_count = Alert.get_counts_by_status(query)
total = sum(severity_count.values())
paging = Page.from_params(request.args, total)
alerts = Alert.find_all(query, raw_data=show_raw_data, history=show_history, page=paging.page, page_size=paging.page_size)
if alerts:
return jsonify(
status='ok',
page=paging.page,
pageSize=paging.page_size,
pages=paging.pages,
more=paging.has_more,
alerts=[alert.serialize for alert in alerts],
total=total,
statusCounts=status_count,
severityCounts=severity_count,
lastTime=max([alert.last_receive_time for alert in alerts]),
autoRefresh=Switch.find_by_name('auto-refresh-allow').is_on
)
else:
return jsonify(
status='ok',
message='not found',
page=paging.page,
pageSize=paging.page_size,
pages=0,
more=False,
alerts=[],
total=0,
severityCounts=severity_count,
statusCounts=status_count,
lastTime=query_time,
autoRefresh=Switch.find_by_name('auto-refresh-allow').is_on
)
@api.route('/alerts/history', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def history():
query = qb.alerts.from_params(request.args, customers=g.customers)
paging = Page.from_params(request.args, items=0)
history = Alert.get_history(query, paging.page, paging.page_size)
if history:
return jsonify(
status='ok',
history=[h.serialize for h in history],
total=len(history)
)
else:
return jsonify(
status='ok',
message='not found',
history=[],
total=0
)
# severity counts
# status counts
@api.route('/alerts/count', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(count_timer)
@jsonp
def get_counts():
query = qb.alerts.from_params(request.args, customers=g.customers)
severity_count = Alert.get_counts_by_severity(query)
status_count = Alert.get_counts_by_status(query)
return jsonify(
status='ok',
total=sum(severity_count.values()),
severityCounts=severity_count,
statusCounts=status_count,
autoRefresh=Switch.find_by_name('auto-refresh-allow').is_on
)
# top 10 counts
@api.route('/alerts/top10/count', methods=['OPTIONS', 'GET'])
@api.route('/alerts/topn/count', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(count_timer)
@jsonp
def get_topn_count():
query = qb.alerts.from_params(request.args, customers=g.customers)
paging = Page.from_params(request.args, 1)
topn = Alert.get_topn_count(query, topn=paging.page_size)
if topn:
return jsonify(
status='ok',
top10=topn,
total=len(topn)
)
else:
return jsonify(
status='ok',
message='not found',
top10=[],
total=0
)
# top 10 flapping
@api.route('/alerts/top10/flapping', methods=['OPTIONS', 'GET'])
@api.route('/alerts/topn/flapping', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(count_timer)
@jsonp
def get_topn_flapping():
query = qb.alerts.from_params(request.args, customers=g.customers)
paging = Page.from_params(request.args, 1)
topn = Alert.get_topn_flapping(query, topn=paging.page_size)
if topn:
return jsonify(
status='ok',
top10=topn,
total=len(topn)
)
else:
return jsonify(
status='ok',
message='not found',
top10=[],
total=0
)
# top 10 standing
@api.route('/alerts/top10/standing', methods=['OPTIONS', 'GET'])
@api.route('/alerts/topn/standing', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(count_timer)
@jsonp
def get_topn_standing():
query = qb.alerts.from_params(request.args, customers=g.customers)
paging = Page.from_params(request.args, 1)
topn = Alert.get_topn_standing(query, topn=paging.page_size)
if topn:
return jsonify(
status='ok',
top10=topn,
total=len(topn)
)
else:
return jsonify(
status='ok',
message='not found',
top10=[],
total=0
)
# get alert environments
@api.route('/environments', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def get_environments():
query = qb.alerts.from_params(request.args, customers=g.customers)
environments = Alert.get_environments(query)
if environments:
return jsonify(
status='ok',
environments=environments,
total=len(environments)
)
else:
return jsonify(
status='ok',
message='not found',
environments=[],
total=0
)
# get alert services
@api.route('/services', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def get_services():
query = qb.alerts.from_params(request.args, customers=g.customers)
services = Alert.get_services(query)
if services:
return jsonify(
status='ok',
services=services,
total=len(services)
)
else:
return jsonify(
status='ok',
message='not found',
services=[],
total=0
)
# get alert groups
@api.route('/alerts/groups', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def get_groups():
query = qb.alerts.from_params(request.args, customers=g.customers)
groups = Alert.get_groups(query)
if groups:
return jsonify(
status='ok',
groups=groups,
total=len(groups)
)
else:
return jsonify(
status='ok',
message='not found',
groups=[],
total=0
)
# get alert tags
@api.route('/alerts/tags', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@timer(gets_timer)
@jsonp
def get_tags():
query = qb.alerts.from_params(request.args, customers=g.customers)
tags = Alert.get_tags(query)
if tags:
return jsonify(
status='ok',
tags=tags,
total=len(tags)
)
else:
return jsonify(
status='ok',
message='not found',
tags=[],
total=0
)
# add note
@api.route('/alert/<alert_id>/note', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@jsonp
def add_note(alert_id):
note_text = request.json.get('text') or request.json.get('note')
if not note_text:
raise ApiError("must supply 'note' text", 400)
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
try:
alert, note_text = process_note(alert, note_text)
note = alert.add_note(note_text)
except RejectException as e:
write_audit_trail.send(current_app._get_current_object(), event='alert-note-rejected', message='',
user=g.login, customers=g.customers, scopes=g.scopes, resource_id=note.id, type='note',
request=request)
raise ApiError(str(e), 400)
except ForwardingLoop as e:
return jsonify(status='ok', message=str(e)), 202
except AlertaException as e:
raise ApiError(e.message, code=e.code, errors=e.errors)
except Exception as e:
raise ApiError(str(e), 500)
write_audit_trail.send(current_app._get_current_object(), event='alert-note-added', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=note.id, type='note', request=request)
if note:
return jsonify(status='ok', id=note.id, note=note.serialize), 201, {'Location': absolute_url(f'/alert/{alert.id}/note/{note.id}')}
else:
raise ApiError('failed to add note for alert', 500)
# list notes for an alert
@api.route('/alert/<alert_id>/notes', methods=['OPTIONS', 'GET'])
@cross_origin()
@permission(Scope.read_alerts)
@jsonp
def get_notes(alert_id):
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
notes = alert.get_alert_notes()
if notes:
return jsonify(
status='ok',
notes=[note.serialize for note in notes],
total=len(notes)
)
else:
return jsonify(
status='ok',
message='not found',
notes=[],
total=0
)
# update note
@api.route('/alert/<alert_id>/note/<note_id>', methods=['OPTIONS', 'PUT'])
@cross_origin()
@permission(Scope.write_alerts)
@jsonp
def update_note(alert_id, note_id):
if not request.json:
raise ApiError('nothing to change', 400)
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('not found', 404)
note = Note.find_by_id(note_id)
if not note:
raise ApiError('not found', 404)
update = request.json
update['user'] = g.login
write_audit_trail.send(current_app._get_current_object(), event='alert-note-updated', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=note.id, type='note',
request=request)
_, update['text'] = process_note(alert, update.get('text'))
updated = note.update(**update)
if updated:
return jsonify(status='ok', note=updated.serialize)
else:
raise ApiError('failed to update note', 500)
# delete note
@api.route('/alert/<alert_id>/note/<note_id>', methods=['OPTIONS', 'DELETE'])
@cross_origin()
@permission(Scope.write_alerts)
@jsonp
def delete_note(alert_id, note_id):
customers = g.get('customers', None)
alert = Alert.find_by_id(alert_id, customers)
if not alert:
raise ApiError('alert not found', 404)
note = Note.find_by_id(note_id)
if not note:
raise ApiError('note not found', 404)
write_audit_trail.send(current_app._get_current_object(), event='alert-note-deleted', message='', user=g.login,
customers=g.customers, scopes=g.scopes, resource_id=note.id, type='note', request=request)
if alert.delete_note(note_id):
return jsonify(status='ok')
else:
raise ApiError('failed to delete note', 500)