feat : Show Github Integration Demo on a Python Codebase #11

SkySingh04 · 2025-03-14T18:35:09Z

No description provided.

Signed-off-by: Sky Singh <akashsingh2210670@gmail.com>

github-actions · 2025-03-14T18:36:21Z

I've analyzed the Python codebase and identified opportunities to add observability instrumentation. Here are my recommendations, sorted by priority:

High Priority:

Add OpenTelemetry tracing to route handlers to track API request flows
Add error handling with proper logging and span status updates
Instrument critical business operations (order creation, refunds, etc.)

Medium Priority:

Add metrics for endpoint latency and error rates
Track user actions via Amplitude events
Add contextual logging for business operations

Low Priority:

Add debug logging for development troubleshooting
Add span attributes for additional context

Here are my specific recommendations:

FILE: test-app/main.py LINE: 4 SUGGESTION: ```diff # app.py from flask import Flask from routes import user_routes, product_routes, order_routes + import logging + from opentelemetry import trace + from opentelemetry.instrumentation.flask import FlaskInstrumentor + from opentelemetry.sdk.trace import TracerProvider + from opentelemetry.sdk.resources import SERVICE_NAME, Resource def create_app(): app = Flask(__name__) + # Configure logging + logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s') + + # Configure OpenTelemetry + trace.set_tracer_provider(TracerProvider(resource=Resource.create({SERVICE_NAME: "test-app"}))) + FlaskInstrumentor().instrument_app(app) app.register_blueprint(user_routes.bp) app.register_blueprint(product_routes.bp) app.register_blueprint(order_routes.bp) + + # Register error handlers + @app.errorhandler(500) + def server_error(e): + logging.error(f"Server error: {str(e)}") + return {"error": "Internal server error"}, 500 return app

FILE: test-app/routes/order_routes.py LINE: 2 SUGGESTION: ```diff # routes/order_routes.py from flask import Blueprint, jsonify, request from services.order_service import create_order, get_order_by_id, update_order_by_id, delete_order_by_id + import logging + from opentelemetry import trace + import amplitude + tracer = trace.get_tracer(__name__) + logger = logging.getLogger(__name__) bp = Blueprint('order', __name__, url_prefix='/orders') @bp.route('/create', methods=['POST']) def new_order(): + with tracer.start_as_current_span("create_order") as span: + logger.info("Processing order creation request") + span.set_attribute("http.method", "POST") + span.set_attribute("endpoint", "/orders/create") + + try: + data = request.json + span.set_attribute("order.data", str(data)) + result = create_order(data) + + # Track order creation event + amplitude.track({ + "event_type": "order_created", + "user_id": data.get("user_id", "unknown"), + "event_properties": { + "order_id": result.get("order", {}).get("id", "unknown"), + "total_amount": data.get("amount", 0) + } + }) + + logger.info(f"Order created successfully: {result}") + return jsonify(result) + except Exception as e: + logger.error(f"Error creating order: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to create order"}), 500 - data = request.json - return jsonify(create_order(data))

FILE: test-app/routes/order_routes.py LINE: 13 SUGGESTION: ```diff @bp.route('/<id>', methods=['GET']) def get_order(id): + with tracer.start_as_current_span("get_order") as span: + logger.info(f"Retrieving order with ID: {id}") + span.set_attribute("http.method", "GET") + span.set_attribute("endpoint", f"/orders/{id}") + span.set_attribute("order.id", id) + + try: + order = get_order_by_id(id) + if order: + logger.info(f"Order found: {order}") + return jsonify(order) + + logger.warning(f"Order not found with ID: {id}") + span.set_attribute("order.found", False) + return jsonify({"message": "Order not found"}), 404 + except Exception as e: + logger.error(f"Error retrieving order {id}: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to retrieve order"}), 500 - order = get_order_by_id(id) - if order: - return jsonify(order) - return jsonify({"message": "Order not found"}), 404

FILE: test-app/routes/order_routes.py LINE: 20 SUGGESTION: ```diff @bp.route('/<id>', methods=['PUT']) def update_order(id): + with tracer.start_as_current_span("update_order") as span: + logger.info(f"Updating order with ID: {id}") + span.set_attribute("http.method", "PUT") + span.set_attribute("endpoint", f"/orders/{id}") + span.set_attribute("order.id", id) + + try: + data = request.json + span.set_attribute("order.update_data", str(data)) + updated_order = update_order_by_id(id, data) + + if updated_order: + logger.info(f"Order updated successfully: {updated_order}") + + # Track order update event + amplitude.track({ + "event_type": "order_updated", + "user_id": data.get("user_id", "unknown"), + "event_properties": { + "order_id": id, + "update_fields": list(data.keys()) + } + }) + + return jsonify(updated_order) + + logger.warning(f"Order not found for update with ID: {id}") + span.set_attribute("order.found", False) + return jsonify({"message": "Order not found"}), 404 + except Exception as e: + logger.error(f"Error updating order {id}: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to update order"}), 500 - data = request.json - updated_order = update_order_by_id(id, data) - if updated_order: - return jsonify(updated_order) - return jsonify({"message": "Order not found"}), 404

FILE: test-app/routes/order_routes.py LINE: 27 SUGGESTION: ```diff @bp.route('/<id>', methods=['DELETE']) def delete_order(id): + with tracer.start_as_current_span("delete_order") as span: + logger.info(f"Deleting order with ID: {id}") + span.set_attribute("http.method", "DELETE") + span.set_attribute("endpoint", f"/orders/{id}") + span.set_attribute("order.id", id) + + try: + result = delete_order_by_id(id) + if result: + logger.info(f"Order deleted successfully: {id}") + + # Track order deletion event + amplitude.track({ + "event_type": "order_deleted", + "event_properties": { + "order_id": id + } + }) + + return jsonify({"message": "Order deleted"}) + + logger.warning(f"Order not found for deletion with ID: {id}") + span.set_attribute("order.found", False) + return jsonify({"message": "Order not found"}), 404 + except Exception as e: + logger.error(f"Error deleting order {id}: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to delete order"}), 500 - if delete_order_by_id(id): - return jsonify({"message": "Order deleted"}) - return jsonify({"message": "Order not found"}), 404

FILE: test-app/routes/product_routes.py LINE: 2 SUGGESTION: ```diff # routes/product_routes.py from flask import Blueprint, jsonify, request from services.product_service import get_products, create_product, get_product, update_product, delete_product, search_products + import logging + from opentelemetry import trace + import amplitude + tracer = trace.get_tracer(__name__) + logger = logging.getLogger(__name__) bp = Blueprint('product', __name__, url_prefix='/products')

FILE: test-app/routes/product_routes.py LINE: 8 SUGGESTION: ```diff @bp.route('/', methods=['GET']) def list_products(): + with tracer.start_as_current_span("list_products") as span: + logger.info("Retrieving product list") + span.set_attribute("http.method", "GET") + span.set_attribute("endpoint", "/products/") + + try: + products = get_products() + span.set_attribute("products.count", len(products)) + logger.info(f"Retrieved {len(products)} products") + return jsonify(products) + except Exception as e: + logger.error(f"Error retrieving products: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to retrieve products"}), 500 - return jsonify(get_products())

FILE: test-app/routes/product_routes.py LINE: 12 SUGGESTION: ```diff @bp.route('/<id>', methods=['GET']) def get_product_by_id(id): + with tracer.start_as_current_span("get_product") as span: + logger.info(f"Retrieving product with ID: {id}") + span.set_attribute("http.method", "GET") + span.set_attribute("endpoint", f"/products/{id}") + span.set_attribute("product.id", id) + + try: + product = get_product(id) + if product: + logger.info(f"Product found: {product}") + return jsonify(product) + + logger.warning(f"Product not found with ID: {id}") + span.set_attribute("product.found", False) + return jsonify({'message': 'Product not found'}), 404 + except Exception as e: + logger.error(f"Error retrieving product {id}: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to retrieve product"}), 500 - product = get_product(id) - if product: - return jsonify(product) - return jsonify({'message': 'Product not found'}), 404

FILE: test-app/routes/product_routes.py LINE: 19 SUGGESTION: ```diff @bp.route('/', methods=['POST']) def add_product(): + with tracer.start_as_current_span("create_product") as span: + logger.info("Processing product creation request") + span.set_attribute("http.method", "POST") + span.set_attribute("endpoint", "/products/") + + try: + data = request.get_json() + span.set_attribute("product.data", str(data)) + product = create_product(data) + + # Track product creation event + amplitude.track({ + "event_type": "product_created", + "event_properties": { + "product_id": product.get("id", "unknown"), + "product_name": data.get("name", "unknown") + } + }) + + logger.info(f"Product created successfully: {product}") + return jsonify(product), 201 + except Exception as e: + logger.error(f"Error creating product: {str(e)}") + span.set_status(trace.StatusCode.ERROR, str(e)) + return jsonify({"error": "Failed to create product"}), 500 - data = request.get_json() - product = create_product(data) - return jsonify(product), 201

FILE: test-app/routes/refund_routes.py LINE: 1 SUGGESTION: ```diff from flask import Blueprint, request, jsonify + import logging + from opentelemetry import trace + import amplitude + tracer = trace.get_tracer(__name__) + logger = logging.getLogger(__name__) refund_bp = Blueprint('refund', __name__, url_prefix='/refund')

FILE: test-app/routes/refund_routes.py LINE: 6 SUGGESTION: ```diff @refund_bp.route('/', methods=['POST']) def create_refund(): + with tracer.start_as_current_span("create_refund") as span: + logger.info("Processing refund creation request") + span.set_attribute("http.method", "POST") + span.set_attribute("endpoint", "/refund/") + + try: + data = request.get_json() + span.set_attribute("refund.data", str(data)) + + # Process the refund creation logic here + # Example: + order_id = data.get('order_id') + amount = data.get('amount') + + span.set_attribute("refund.order_id", order_id) + span.set_attribute("refund.amount", amount) + + if not order_id or not amount: + logger.warning(f"Invalid refund request: missing order_id or amount") + span.set_status(trace.StatusCode.ERROR, "Missing required fields") + return jsonify({'error': 'Order ID and amount are required'}), 400 + + # In a real application, you would interact with a database or payment gateway here + # For this example, we'll just return a success message + + # Track refund creation event + amplitude.track({ + "event_type": "refund_initiated", + "event_properties": { +

github-actions · 2025-03-14T18:36:22Z

test-app/main.py

+# app.py
+from flask import Flask
+from routes import user_routes, product_routes, order_routes
+


Suggested change

import logging

from opentelemetry import trace

from opentelemetry.instrumentation.flask import FlaskInstrumentor

from opentelemetry.sdk.trace import TracerProvider

from opentelemetry.sdk.resources import SERVICE_NAME, Resource

# Configure logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# Configure OpenTelemetry

trace.set_tracer_provider(TracerProvider(resource=Resource.create({SERVICE_NAME: "test-app"})))

FlaskInstrumentor().instrument_app(app)

# Register error handlers

@app.errorhandler(500)

def server_error(e):

logging.error(f"Server error: {str(e)}")

return {"error": "Internal server error"}, 500

github-actions · 2025-03-14T18:36:23Z

test-app/routes/order_routes.py

@@ -0,0 +1,31 @@
+# routes/order_routes.py
+from flask import Blueprint, jsonify, request


Suggested change

from flask import Blueprint, jsonify, request

import logging

from opentelemetry import trace

import amplitude

tracer = trace.get_tracer(__name__)

logger = logging.getLogger(__name__)

with tracer.start_as_current_span("create_order") as span:

logger.info("Processing order creation request")

span.set_attribute("http.method", "POST")

span.set_attribute("endpoint", "/orders/create")

try:

data = request.json

span.set_attribute("order.data", str(data))

result = create_order(data)

# Track order creation event

amplitude.track({

"event_type": "order_created",

"user_id": data.get("user_id", "unknown"),

"event_properties": {

"order_id": result.get("order", {}).get("id", "unknown"),

"total_amount": data.get("amount", 0)

}

})

logger.info(f"Order created successfully: {result}")

return jsonify(result)

except Exception as e:

logger.error(f"Error creating order: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to create order"}), 500

github-actions · 2025-03-14T18:36:24Z

test-app/routes/order_routes.py

+ return jsonify(create_order(data))
+
+@bp.route('/<id>', methods=['GET'])
+def get_order(id):


Suggested change

def get_order(id):

with tracer.start_as_current_span("get_order") as span:

logger.info(f"Retrieving order with ID: {id}")

span.set_attribute("http.method", "GET")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

try:

order = get_order_by_id(id)

if order:

logger.info(f"Order found: {order}")

return jsonify(order)

logger.warning(f"Order not found with ID: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

logger.error(f"Error retrieving order {id}: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to retrieve order"}), 500

github-actions · 2025-03-14T18:36:25Z

test-app/routes/order_routes.py

+ return jsonify({"message": "Order not found"}), 404
+
+@bp.route('/<id>', methods=['PUT'])
+def update_order(id):


Suggested change

def update_order(id):

with tracer.start_as_current_span("update_order") as span:

logger.info(f"Updating order with ID: {id}")

span.set_attribute("http.method", "PUT")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

try:

data = request.json

span.set_attribute("order.update_data", str(data))

updated_order = update_order_by_id(id, data)

if updated_order:

logger.info(f"Order updated successfully: {updated_order}")

# Track order update event

amplitude.track({

"event_type": "order_updated",

"user_id": data.get("user_id", "unknown"),

"event_properties": {

"order_id": id,

"update_fields": list(data.keys())

}

})

return jsonify(updated_order)

logger.warning(f"Order not found for update with ID: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

logger.error(f"Error updating order {id}: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to update order"}), 500

github-actions · 2025-03-14T18:36:26Z

test-app/routes/order_routes.py

+ return jsonify(updated_order)
+ return jsonify({"message": "Order not found"}), 404
+
+@bp.route('/<id>', methods=['DELETE'])


Suggested change

@bp.route('/<id>', methods=['DELETE'])

with tracer.start_as_current_span("delete_order") as span:

logger.info(f"Deleting order with ID: {id}")

span.set_attribute("http.method", "DELETE")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

try:

result = delete_order_by_id(id)

if result:

logger.info(f"Order deleted successfully: {id}")

# Track order deletion event

amplitude.track({

"event_type": "order_deleted",

"event_properties": {

"order_id": id

}

})

return jsonify({"message": "Order deleted"})

logger.warning(f"Order not found for deletion with ID: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

logger.error(f"Error deleting order {id}: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to delete order"}), 500

github-actions · 2025-03-14T18:36:26Z

test-app/routes/product_routes.py

@@ -0,0 +1,44 @@
+# routes/product_routes.py
+from flask import Blueprint, jsonify, request


Suggested change

from flask import Blueprint, jsonify, request

import logging

from opentelemetry import trace

import amplitude

tracer = trace.get_tracer(__name__)

logger = logging.getLogger(__name__)

github-actions · 2025-03-14T18:36:27Z

test-app/routes/product_routes.py

+bp = Blueprint('product', __name__, url_prefix='/products')
+
+@bp.route('/', methods=['GET'])
+def list_products():


Suggested change

def list_products():

with tracer.start_as_current_span("list_products") as span:

logger.info("Retrieving product list")

span.set_attribute("http.method", "GET")

span.set_attribute("endpoint", "/products/")

try:

products = get_products()

span.set_attribute("products.count", len(products))

logger.info(f"Retrieved {len(products)} products")

return jsonify(products)

except Exception as e:

logger.error(f"Error retrieving products: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to retrieve products"}), 500

github-actions · 2025-03-14T18:36:28Z

test-app/routes/product_routes.py

+ return jsonify(get_products())
+
+@bp.route('/<id>', methods=['GET'])
+def get_product_by_id(id):


Suggested change

def get_product_by_id(id):

with tracer.start_as_current_span("get_product") as span:

logger.info(f"Retrieving product with ID: {id}")

span.set_attribute("http.method", "GET")

span.set_attribute("endpoint", f"/products/{id}")

span.set_attribute("product.id", id)

try:

product = get_product(id)

if product:

logger.info(f"Product found: {product}")

return jsonify(product)

logger.warning(f"Product not found with ID: {id}")

span.set_attribute("product.found", False)

return jsonify({'message': 'Product not found'}), 404

except Exception as e:

logger.error(f"Error retrieving product {id}: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to retrieve product"}), 500

github-actions · 2025-03-14T18:36:28Z

test-app/routes/product_routes.py

+ return jsonify({'message': 'Product not found'}), 404
+
+@bp.route('/', methods=['POST'])
+def add_product():


Suggested change

def add_product():

with tracer.start_as_current_span("create_product") as span:

logger.info("Processing product creation request")

span.set_attribute("http.method", "POST")

span.set_attribute("endpoint", "/products/")

try:

data = request.get_json()

span.set_attribute("product.data", str(data))

product = create_product(data)

# Track product creation event

amplitude.track({

"event_type": "product_created",

"event_properties": {

"product_id": product.get("id", "unknown"),

"product_name": data.get("name", "unknown")

}

})

logger.info(f"Product created successfully: {product}")

return jsonify(product), 201

except Exception as e:

logger.error(f"Error creating product: {str(e)}")

span.set_status(trace.StatusCode.ERROR, str(e))

return jsonify({"error": "Failed to create product"}), 500

github-actions · 2025-03-14T18:36:29Z

test-app/routes/refund_routes.py

@@ -0,0 +1,38 @@
+from flask import Blueprint, request, jsonify


Suggested change

from flask import Blueprint, request, jsonify

import logging

from opentelemetry import trace

import amplitude

tracer = trace.get_tracer(__name__)

logger = logging.getLogger(__name__)

github-actions · 2025-03-14T18:37:16Z

Dashboard Suggestion: Flask API Service Overview

Type: grafana
Priority: High

Queries

[ { "refId": "A", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\"}[5m])) by (route)", "legendFormat": "{{route}}", "interval": "30s" }, { "refId": "B", "datasource": "Prometheus", "expr": "histogram_quantile(0.95, sum(rate(http_server_duration_seconds_bucket{service_name=\"flask-app\"}[5m])) by (route, le))", "legendFormat": "p95 {{route}}", "interval": "30s" }, { "refId": "C", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", status_code=~\"5..\"}[5m])) by (route) / sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\"}[5m])) by (route)", "legendFormat": "Error % {{route}}", "interval": "30s" } ]

Panels

[ { "title": "Request Rate by Endpoint", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 0, "y": 0 }, "targets": ["A"] }, { "title": "p95 Latency by Endpoint", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 12, "y": 0 }, "targets": ["B"] }, { "title": "Error Rate by Endpoint", "type": "timeseries", "gridPos": { "h": 8, "w": 24, "x": 0, "y": 8 }, "targets": ["C"] } ]

Alerts

[ { "name": "High Error Rate", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", status_code=~\"5..\"}[5m])) / sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\"}[5m])) > 0.05", "for": "5m", "severity": "warning" }, { "name": "High Latency", "expr": "histogram_quantile(0.95, sum(rate(http_server_duration_seconds_bucket{service_name=\"flask-app\"}[5m])) by (le)) > 1", "for": "5m", "severity": "warning" } ]

Click to create this dashboard

To create this dashboard, comment with:

prism dashboard --create Flask API Service Overview

github-actions · 2025-03-14T18:37:17Z

Dashboard Suggestion: E-commerce Business Metrics

Type: grafana
Priority: Medium

Queries

[ { "refId": "A", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=\"/orders/create\", status_code=~\"2..\"}[5m]))", "legendFormat": "Order Creation Rate", "interval": "30s" }, { "refId": "B", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=\"/refund\", http_method=\"POST\", status_code=~\"2..\"}[5m]))", "legendFormat": "Refund Rate", "interval": "30s" }, { "refId": "C", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=\"/products/search\", status_code=~\"2..\"}[5m]))", "legendFormat": "Product Search Rate", "interval": "30s" } ]

Panels

[ { "title": "Order Creation Rate", "type": "timeseries", "gridPos": { "h": 8, "w": 8, "x": 0, "y": 0 }, "targets": ["A"] }, { "title": "Refund Rate", "type": "timeseries", "gridPos": { "h": 8, "w": 8, "x": 8, "y": 0 }, "targets": ["B"] }, { "title": "Product Search Rate", "type": "timeseries", "gridPos": { "h": 8, "w": 8, "x": 16, "y": 0 }, "targets": ["C"] } ]

Alerts

[ { "name": "Order Creation Drop", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=\"/orders/create\", status_code=~\"2..\"}[30m])) < sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=\"/orders/create\", status_code=~\"2..\"}[30m] offset 1d)) * 0.5", "for": "15m", "severity": "warning" } ]

Click to create this dashboard

To create this dashboard, comment with:

prism dashboard --create E-commerce Business Metrics

github-actions · 2025-03-14T18:37:17Z

Dashboard Suggestion: Payment Services Performance

Type: grafana
Priority: High

Queries

[ { "refId": "A", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=~\"/remittance/.*\"}[5m])) by (route)", "legendFormat": "{{route}}", "interval": "30s" }, { "refId": "B", "datasource": "Prometheus", "expr": "histogram_quantile(0.95, sum(rate(http_server_duration_seconds_bucket{service_name=\"flask-app\", route=~\"/remittance/.*\"}[5m])) by (route, le))", "legendFormat": "p95 {{route}}", "interval": "30s" }, { "refId": "C", "datasource": "Prometheus", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=~\"/refund/.*\"}[5m])) by (route)", "legendFormat": "{{route}}", "interval": "30s" }, { "refId": "D", "datasource": "Prometheus", "expr": "histogram_quantile(0.95, sum(rate(http_server_duration_seconds_bucket{service_name=\"flask-app\", route=~\"/refund/.*\"}[5m])) by (route, le))", "legendFormat": "p95 {{route}}", "interval": "30s" } ]

Panels

[ { "title": "Remittance Request Rate", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 0, "y": 0 }, "targets": ["A"] }, { "title": "Remittance Latency (p95)", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 12, "y": 0 }, "targets": ["B"] }, { "title": "Refund Request Rate", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 0, "y": 8 }, "targets": ["C"] }, { "title": "Refund Latency (p95)", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 12, "y": 8 }, "targets": ["D"] } ]

Alerts

[ { "name": "Slow Remittance Processing", "expr": "histogram_quantile(0.95, sum(rate(http_server_duration_seconds_bucket{service_name=\"flask-app\", route=\"/remittance/send\"}[5m])) by (le)) > 2", "for": "5m", "severity": "warning" }, { "name": "Refund Service Errors", "expr": "sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=~\"/refund/.*\", status_code=~\"5..\"}[5m])) / sum(rate(http_server_duration_seconds_count{service_name=\"flask-app\", route=~\"/refund/.*\"}[5m])) > 0.05", "for": "5m", "severity": "warning" } ]

Click to create this dashboard

To create this dashboard, comment with:

prism dashboard --create Payment Services Performance

github-actions · 2025-03-14T18:37:18Z

Dashboard Suggestion: Flask Application Overview

Type: datadog
Priority: High

Queries

[ { "refId": "A", "datasource": "Datadog", "query": "sum:trace.http.server.duration.by.resource_name{service:flask-app}.as_count().rollup(sum, 60)", "aggregator": "sum", "alias": "Request Count by Endpoint" }, { "refId": "B", "datasource": "Datadog", "query": "p95:trace.http.server.duration{service:flask-app} by {resource_name}", "aggregator": "avg", "alias": "p95 Latency by Endpoint" }, { "refId": "C", "datasource": "Datadog", "query": "sum:trace.http.server.duration.by.resource_name{service:flask-app,http.status_code:5xx}.as_count().rollup(sum, 60) / sum:trace.http.server.duration.by.resource_name{service:flask-app}.as_count().rollup(sum, 60) * 100", "aggregator": "avg", "alias": "Error Rate %" } ]

Panels

[ { "title": "Request Volume by Endpoint", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 0, "y": 0 }, "targets": ["A"] }, { "title": "p95 Latency by Endpoint", "type": "timeseries", "gridPos": { "h": 8, "w": 12, "x": 12, "y": 0 }, "targets": ["B"] }, { "title": "Error Rate %", "type": "timeseries", "gridPos": { "h": 8, "w": 24, "x": 0, "y": 8 }, "targets": ["C"] } ]

Alerts

[ { "name": "High API Error Rate", "query": "sum:trace.http.server.duration.by.resource_name{service:flask-app,http.status_code:5xx}.as_count().rollup(sum, 300) / sum:trace.http.server.duration.by.resource_name{service:flask-app}.as_count().rollup(sum, 300) * 100 > 5", "warning_threshold": 3, "critical_threshold": 5, "notify_no_data": false, "require_full_window": false }, { "name": "High API Latency", "query": "avg:trace.http.server.duration{service:flask-app} by {resource_name} > 1", "warning_threshold": 0.5, "critical_threshold": 1, "notify_no_data": false, "require_full_window": false } ]

Click to create this dashboard

To create this dashboard, comment with:

prism dashboard --create Flask Application Overview

github-actions · 2025-03-14T18:37:18Z

Create All Dashboards

To create all suggested dashboards, comment with:

prism dashboard --create-all

github-actions · 2025-03-14T18:37:43Z

Alert Suggestion: HighErrorRateAcrossAPIs

Type: metric
Priority: P0

Query

sum(rate(http_server_duration_count{status_code=~"5.."}[5m])) / sum(rate(http_server_duration_count[5m])) > 0.05

Description

High rate of 5xx errors across all API endpoints

Threshold

5%

Duration

5m

Notification

slack-sre-channel

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create HighErrorRateAcrossAPIs

github-actions · 2025-03-14T18:37:43Z

Alert Suggestion: APILatencySpike

Type: metric
Priority: P1

Query

histogram_quantile(0.95, sum by(le, route) (rate(http_server_duration_bucket[5m]))) > 1.0

Description

95th percentile latency for API endpoints is above 1 second

Threshold

1.0 seconds

Duration

5m

Notification

slack-sre-channel

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create APILatencySpike

github-actions · 2025-03-14T18:37:43Z

Alert Suggestion: HighNotFoundRate

Type: metric
Priority: P2

Query

sum(rate(http_server_duration_count{status_code="404"}[5m])) / sum(rate(http_server_duration_count[5m])) > 0.10

Description

Unusually high rate of 404 responses, may indicate client issues or missing resources

Threshold

10%

Duration

5m

Notification

slack-sre-channel

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create HighNotFoundRate

github-actions · 2025-03-14T18:37:44Z

Alert Suggestion: RefundAPIErrorRate

Type: metric
Priority: P1

Query

sum(rate(http_server_duration_count{route=~"/refund.*", status_code=~"5.."}[5m])) / sum(rate(http_server_duration_count{route=~"/refund.*"}[5m])) > 0.03

Description

Refund API is experiencing a high error rate

Threshold

3%

Duration

5m

Notification

slack-payments-team

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create RefundAPIErrorRate

github-actions · 2025-03-14T18:37:44Z

Alert Suggestion: RemittanceProcessingLatency

Type: metric
Priority: P1

Query

histogram_quantile(0.95, sum by(le) (rate(http_server_duration_bucket{route="/remittance/send"}[5m]))) > 2.0

Description

Remittance processing is taking longer than expected

Threshold

2.0 seconds

Duration

5m

Notification

slack-payments-team

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create RemittanceProcessingLatency

github-actions · 2025-03-14T18:37:45Z

Alert Suggestion: CriticalApplicationErrors

Type: log
Priority: P0

Query

{app="flask-app"} |= "ERROR" | json | level="error" | count() > 10

Description

High number of error-level log entries

Threshold

10 errors

Duration

5m

Notification

slack-sre-channel

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create CriticalApplicationErrors

github-actions · 2025-03-14T18:37:45Z

Alert Suggestion: PaymentProcessingFailures

Type: log
Priority: P0

Query

{app="flask-app"} |= "ERROR" |= "payment" | json | count() > 5

Description

Multiple payment processing failures detected

Threshold

5 errors

Duration

5m

Notification

slack-payments-team

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create PaymentProcessingFailures

github-actions · 2025-03-14T18:37:45Z

Alert Suggestion: BadRequestSpike

Type: log
Priority: P2

Query

{app="flask-app"} |= "400 Bad Request" | json | count() > 50

Description

Unusual spike in bad requests, may indicate client integration issues

Threshold

50 bad requests

Duration

5m

Notification

slack-api-team

Runbook

Link to Runbook

Click to create this alert

To create this alert, comment with:

prism alert --create BadRequestSpike

github-actions · 2025-03-14T18:37:46Z

Create All Alerts

To create all suggested alerts, comment with:

prism alert --create-all

SkySingh04 · 2025-03-14T18:38:30Z

prism check

github-actions · 2025-03-14T18:39:42Z

The PR introduces a new Python Flask application with multiple endpoints but lacks proper observability. My recommendations focus on:

HIGH PRIORITY: Add OpenTelemetry tracing to all route handlers to track request flow and performance
HIGH PRIORITY: Add structured logging for errors and important operations
MEDIUM PRIORITY: Implement metrics for endpoint latency and error rates
MEDIUM PRIORITY: Add event tracking for key user actions like order creation and refunds
LOW PRIORITY: Add debug logging for complex operations

These changes will provide visibility into application performance, error conditions, and user behavior, replacing the alerting rules that were removed in the PR.

github-actions · 2025-03-14T18:39:42Z

test-app/main.py

@@ -0,0 +1,16 @@
+# app.py


Suggested change

# app.py

import logging

from flask import Flask, request

from opentelemetry import trace

from opentelemetry.instrumentation.flask import FlaskInstrumentor

from opentelemetry.sdk.trace import TracerProvider

from opentelemetry.sdk.trace.export import BatchSpanProcessor

from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter

# Configure logging

logging.basicConfig(

level=logging.INFO,

format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'

)

logger = logging.getLogger(__name__)

# Configure OpenTelemetry

trace.set_tracer_provider(TracerProvider())

tracer = trace.get_tracer(__name__)

span_processor = BatchSpanProcessor(OTLPSpanExporter())

trace.get_tracer_provider().add_span_processor(span_processor)

# Initialize Flask instrumentation

FlaskInstrumentor().instrument_app(app)

logger.info("Initializing Flask application")

@app.before_request

def before_request():

request_id = request.headers.get('X-Request-ID')

if request_id:

trace.get_current_span().set_attribute("request_id", request_id)

logger.debug(f"Processing request: {request.method} {request.path}")

@app.after_request

def after_request(response):

logger.debug(f"Request completed with status: {response.status_code}")

return response

logger.info("Starting Flask application")

github-actions · 2025-03-14T18:39:43Z

test-app/routes/order_routes.py

@@ -0,0 +1,31 @@
+# routes/order_routes.py


Suggested change

# routes/order_routes.py

import logging

import time

import json

from opentelemetry import trace

logger = logging.getLogger(__name__)

tracer = trace.get_tracer(__name__)

with tracer.start_as_current_span("create_order") as span:

start_time = time.time()

logger.info("Processing order creation request")

span.set_attribute("http.method", "POST")

span.set_attribute("endpoint", "/orders/create")

try:

data = request.json

span.set_attribute("order.data", json.dumps(data))

result = create_order(data)

# Track order creation event

# amplitude.track(

# event_type="Order Created",

# event_properties={

# "order_data": data,

# "processing_time": time.time() - start_time

# }

# )

logger.info(f"Order created successfully: {result}")

return jsonify(result)

except Exception as e:

span.record_exception(e)

span.set_status(trace.Status(trace.StatusCode.ERROR))

logger.error(f"Error creating order: {str(e)}", exc_info=True)

return jsonify({"error": "Failed to create order"}), 500

with tracer.start_as_current_span("get_order") as span:

span.set_attribute("http.method", "GET")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

logger.info(f"Retrieving order with ID: {id}")

try:

order = get_order_by_id(id)

if order:

logger.info(f"Order found: {id}")

return jsonify(order)

logger.warning(f"Order not found: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

span.record_exception(e)

span.set_status(trace.Status(trace.StatusCode.ERROR))

logger.error(f"Error retrieving order {id}: {str(e)}", exc_info=True)

return jsonify({"error": "Failed to retrieve order"}), 500

with tracer.start_as_current_span("update_order") as span:

start_time = time.time()

span.set_attribute("http.method", "PUT")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

logger.info(f"Updating order with ID: {id}")

try:

data = request.json

span.set_attribute("order.update_data", json.dumps(data))

updated_order = update_order_by_id(id, data)

if updated_order:

# Track order update event

# amplitude.track(

# event_type="Order Updated",

# event_properties={

# "order_id": id,

# "update_data": data,

# "processing_time": time.time() - start_time

# }

# )

logger.info(f"Order updated successfully: {id}")

return jsonify(updated_order)

logger.warning(f"Order not found for update: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

span.record_exception(e)

span.set_status(trace.Status(trace.StatusCode.ERROR))

logger.error(f"Error updating order {id}: {str(e)}", exc_info=True)

return jsonify({"error": "Failed to update order"}), 500

with tracer.start_as_current_span("delete_order") as span:

span.set_attribute("http.method", "DELETE")

span.set_attribute("endpoint", f"/orders/{id}")

span.set_attribute("order.id", id)

logger.info(f"Deleting order with ID: {id}")

try:

result = delete_order_by_id(id)

if result:

# Track order deletion event

# amplitude.track(

# event_type="Order Deleted",

# event_properties={"order_id": id}

# )

logger.info(f"Order deleted successfully: {id}")

return jsonify({"message": "Order deleted"})

logger.warning(f"Order not found for deletion: {id}")

span.set_attribute("order.found", False)

return jsonify({"message": "Order not found"}), 404

except Exception as e:

span.record_exception(e)

span.set_status(trace.Status(trace.StatusCode.ERROR))

logger.error(f"Error deleting order {id}: {str(e)}", exc_info=True)

return jsonify({"error": "Failed to delete order"}), 500

SkySingh04 · 2025-03-14T18:41:06Z

prism alert --create RefundAPIErrorRate

github-actions · 2025-03-14T18:41:37Z

✅ Successfully created alert!

SkySingh04 · 2025-03-14T18:42:04Z

prism dashboard --create Payment Services Performance

github-actions · 2025-03-14T18:42:30Z

✅ Successfully created dashboard!

chore: remove obsolete metric alert configuration files

dae82b8

Signed-off-by: Sky Singh <akashsingh2210670@gmail.com>

github-actions bot reviewed Mar 14, 2025

View reviewed changes

github-actions bot added 4 commits March 14, 2025 18:41

Add metric alert rule for HighErrorRateAcrossAPIs

ea4d6f4

Add metric alert rule for APILatencySpike

b1a94a5

Add metric alert rule for HighNotFoundRate

942034e

Add metric alert rule for RefundAPIErrorRate

fab95d2

Add metric alert rule for RemittanceProcessingLatency

3cef679

		@@ -0,0 +1,31 @@
		# routes/order_routes.py
		from flask import Blueprint, jsonify, request

		@@ -0,0 +1,44 @@
		# routes/product_routes.py
		from flask import Blueprint, jsonify, request

		@@ -0,0 +1,38 @@
		from flask import Blueprint, request, jsonify

-# app.py
+import logging
+from flask import Flask, request
+from opentelemetry import trace
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+# Configure logging
+logging.basicConfig(
+ level=logging.INFO,
+ format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+)
+logger = logging.getLogger(__name__)
+# Configure OpenTelemetry
+trace.set_tracer_provider(TracerProvider())
+tracer = trace.get_tracer(__name__)
+span_processor = BatchSpanProcessor(OTLPSpanExporter())
+trace.get_tracer_provider().add_span_processor(span_processor)
+ # Initialize Flask instrumentation
+ FlaskInstrumentor().instrument_app(app)
+ logger.info("Initializing Flask application")
+ @app.before_request
+ def before_request():
+ request_id = request.headers.get('X-Request-ID')
+ if request_id:
+ trace.get_current_span().set_attribute("request_id", request_id)
+ logger.debug(f"Processing request: {request.method} {request.path}")
+ @app.after_request
+ def after_request(response):
+ logger.debug(f"Request completed with status: {response.status_code}")
+ return response
+ logger.info("Starting Flask application")

feat : Show Github Integration Demo on a Python Codebase #11

Are you sure you want to change the base?

feat : Show Github Integration Demo on a Python Codebase #11

Uh oh!

Conversation

SkySingh04 commented Mar 14, 2025

github-actions bot commented Mar 14, 2025

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 14, 2025

Dashboard Suggestion: Flask API Service Overview

Queries

Panels

Alerts

github-actions bot commented Mar 14, 2025

Dashboard Suggestion: E-commerce Business Metrics

Queries

Panels

Alerts

github-actions bot commented Mar 14, 2025

Dashboard Suggestion: Payment Services Performance

Queries

Panels

Alerts

github-actions bot commented Mar 14, 2025

Dashboard Suggestion: Flask Application Overview

Queries

Panels

Alerts

github-actions bot commented Mar 14, 2025

Create All Dashboards

github-actions bot commented Mar 14, 2025

Alert Suggestion: HighErrorRateAcrossAPIs

Query

Description

Threshold

Duration

Notification

Runbook

github-actions bot commented Mar 14, 2025

Alert Suggestion: APILatencySpike

Query

Description

Threshold

Duration

Notification

Runbook

github-actions bot commented Mar 14, 2025

Alert Suggestion: HighNotFoundRate

Query

Description

Threshold

Duration

Notification

Runbook

github-actions bot commented Mar 14, 2025

Alert Suggestion: RefundAPIErrorRate

Query

Description

Threshold

Duration

Notification