Runbook Templates for Common OAuth Issues
Runbooks provide a standardized set of procedures for operations and troubleshooting common incidents. Having runbook templates for your Mubarokah ID OAuth integration can help your team respond quickly and consistently to issues.🚨 Runbook: Critical - Complete Mubarokah ID Login Failure
Symptoms:- Users report they cannot log in via Mubarokah ID at all.
- All attempts to initiate login (redirect to
/oauth/authorize) fail, or all callbacks from Mubarokah ID result in errors on your application’s side. - Monitoring shows a spike in 5xx errors from your OAuth callback endpoint or high error rates for token exchange.
- Error logs in your application show consistent failures like
invalid_client, persistentinvalid_granteven for new codes, or network errors connecting to Mubarokah ID.
- Verify Mubarokah ID Service Status:
- Check if Mubarokah ID has a publicly available status page.
- Attempt to access a known Mubarokah ID endpoint (e.g., their main website or a status API if available) from a neutral network to check for general availability.
- Command (example):
curl -I https://accounts.mubarokah.com/oauth/authorize(or a known health/status endpoint). Look for HTTP 200 or 302 (for authorize).
- Check Your Application’s Connectivity to Mubarokah ID:
- From your application server(s), test connectivity to
https://accounts.mubarokah.com(or the specific OAuth/API base URL). - Commands (examples):
ping accounts.mubarokah.com(if ICMP is allowed)curl -v https://accounts.mubarokah.com/oauth/token(observe TLS handshake and connection attempt)openssl s_client -connect accounts.mubarokah.com:443
- From your application server(s), test connectivity to
- Review Your Application’s Critical Logs:
- Check logs for your OAuth controller/service, focusing on the period when failures started.
- Look for errors related to: client ID/secret, redirect URI validation, token exchange failures, SSL errors, network timeouts.
- Command (example):
tail -f /var/log/your-app/oauth-errors.logor use your centralized logging platform.
- Verify Client Credentials & Configuration:
- Without exposing secrets in logs/console, confirm that your application is loading the correct
MUBAROKAH_CLIENT_ID,MUBAROKAH_CLIENT_SECRET, andMUBAROKAH_REDIRECT_URIfrom its configuration (environment variables, config files). - Check for recent accidental changes to these configurations.
- Without exposing secrets in logs/console, confirm that your application is loading the correct
- Isolate the Scope:
- Is the failure affecting all users or a subset?
- Did this start after a recent deployment or configuration change on your side? If so, consider immediate rollback if possible.
- Test with Known Working Credentials (if you have a separate test client for Mubarokah ID):
- If you have a separate, known-good test client configuration for Mubarokah ID, try the flow with that to see if the issue is specific to your main production client credentials.
-
Command (conceptual, using Postman or cURL for token endpoint):
(This tests client credential grant, not the full user flow, but can indicate issues with basic client auth).
- Check Redirect URI Configuration:
- Verify the
redirect_uriconfigured in your Mubarokah ID client registration exactly matches what your application is sending and expecting. Pay attention to HTTP vs. HTTPS, trailing slashes, and path.
- Verify the
- Review Application Resource Limits: Check CPU, memory, network, and disk space on your servers to ensure they are not exhausted.
- SSL/TLS Certificate Issues:
- Ensure your server’s SSL certificate (if your callback is HTTPS) is valid and not expired.
- Ensure your server’s list of trusted CA certificates is up-to-date for making outbound calls to Mubarokah ID.
- If Mubarokah ID service status is red or connectivity issues are confirmed to be external to your app, prepare to contact Mubarokah ID support.
- If the issue is isolated to your application but cannot be resolved within [e.g., 1 hour], escalate to [Your Senior Engineering Lead / Relevant Team].
⚠️ Runbook: Warning - High OAuth Error Rate or Latency
Symptoms:- Monitoring shows an increased percentage of 4xx/5xx errors from Mubarokah ID endpoints (e.g.,
invalid_grant,token_expired, intermittent503s). - Users report intermittent login failures or slow login process.
- API calls to Mubarokah ID
/api/userare slower than usual or failing more often.
- Identify Specific Errors & Endpoints:
- Use your monitoring/logging to pinpoint which OAuth errors are most frequent (e.g.,
invalid_grant,invalid_request) or which Mubarokah ID API endpoints are slow/failing. - Command (example for logs):
grep "MubarokahOAuthException" /var/log/your-app/app.log | tail -n 100(or use your logging platform query).
- Use your monitoring/logging to pinpoint which OAuth errors are most frequent (e.g.,
- Check Mubarokah ID Status: As with critical failures, check any Mubarokah ID status pages.
- Assess Scope: Is this affecting a specific feature, user segment, or geographic region?
invalid_grant / token_expired Spike:- Could indicate issues with your token storage or retrieval (e.g., refresh tokens not being used correctly, or clock skew affecting expiry calculations).
- Could be an issue on Mubarokah ID’s side temporarily invalidating codes/tokens faster.
- Review your application’s logic for handling authorization codes (ensure they are used once and promptly) and refresh tokens.
- Increased Latency:
-
Network Path: Use
tracerouteormtrfrom your app server to accounts.mubarokah.com to check for network hops with high latency. - Your Application Performance: Profile your application code that handles OAuth callbacks and API calls to Mubarokah ID. Are there bottlenecks in your code?
- Mubarokah ID API Performance: Check if Mubarokah ID has announced any performance degradations.
-
Command (example for checking response times):
(Replace DUMMY_TOKEN with a test token if needed, or test a public endpoint if one exists).
-
Network Path: Use
Specific 4xx Errors (e.g., invalid_request, invalid_scope):- This often points to an issue in your application’s request formation.
- Check for recent code changes that might have altered how requests are built.
- Validate parameters being sent against Mubarokah ID documentation.
- Intermittent 5xx Errors from Mubarokah ID:
- This usually indicates a temporary issue on Mubarokah ID’s side.
- Ensure your application has retry logic with exponential backoff for such errors on idempotent read operations.
- Monitor if the rate of 5xx errors is increasing or sustained.
- If due to your application code/config: Deploy a fix.
- If due to Mubarokah ID issues:
- Implement circuit breaker pattern if calls are consistently failing to prevent cascading failures in your app.
- Inform users of potential intermittent issues.
- Contact Mubarokah ID support if the issue is severe or prolonged.