​

API Request Logs

​

Overview

• 📋 Every request logged with full details
• 🔍 Filter by status, method, route, client, latency
• 📊 Search request paths and errors
• 💾 Export to CSV (Pro/Enterprise plans)
• 🔗 Deep links from alerts and analytics
• ⏰ Timezone-aware timestamps

​

Log Entry Details

​

Request Information

• Timestamp: When request received (your timezone)
• Method: HTTP method (GET, POST, PUT, DELETE, etc.)
• Path: Request path including query parameters
• Route: Which KnoxCall route handled it
• Environment: Environment used (if specified)

​

Client Information

• Client: Client name/IP that made request
• Source IP: Originating IP address
• User Agent: Client’s user agent string
• Geographic Location: City, country (if available)

​

Response Information

• Status Code: HTTP response code (200, 404, 500, etc.)
• Latency: Response time in milliseconds
• Backend Response: Status from target API
• Error: Error message if request failed

​

Security Information

• API Key: Which key authenticated request (key ID only, not full key)
• Authorization: Whether authorized (client IP whitelisted)
• Secrets Used: Which secrets injected (names only, not values)

​

Viewing Logs

​

Step 1: Navigate to Logs

1. Click Monitoring in sidebar
2. Select API Logs
3. See recent requests (most recent first)

​

Step 2: Use Filters

☐ 2xx Success
☐ 3xx Redirect
☐ 4xx Client Error
☐ 5xx Server Error

☐ GET
☐ POST
☐ PUT
☐ DELETE
☐ PATCH

Min: ___ ms
Max: ___ ms

​

Step 3: View Log Details

Method: POST
Path: /v1/charges?amount=1000
Headers:
  Content-Type: application/json
  x-knoxcall-key: tk_abc***
  x-knoxcall-route: stripe-payments
  x-knoxcall-environment: production
Body:
{
  "amount": 1000,
  "currency": "usd",
  "source": "tok_visa"
}

Status: 200 OK
Latency: 234ms
Headers:
  Content-Type: application/json
  X-Request-ID: req_xyz789
Body:
{
  "id": "ch_abc123",
  "amount": 1000,
  "status": "succeeded"
}

Route: stripe-payments
Environment: production
Client: production-server-01 (52.123.45.67)
API Key: key_abc123... (Production Key)
Secrets Used:
  - stripe-prod-key (injected in Authorization header)
Timestamp: 2025-01-15 10:30:45 EST
Geographic: New York, USA → Virginia, USA

​

Common Use Cases

​

Use Case 1: Debugging Failed Requests

1. Filter by Status: 5xx Server Error
2. Filter by Route: stripe-payments
3. Filter by Time: Last hour
4. Find user’s request
5. View error details
6. Identify issue (e.g., Stripe API down)

​

Use Case 2: Investigating Slow Requests

1. Filter by Route: checkout-route
2. Filter by Latency: Min 2000ms (>2 seconds)
3. Sort by latency (highest first)
4. View slowest requests
5. Check common patterns (specific endpoint? time of day?)
6. Optimize accordingly

​

Use Case 3: Security Audit

1. Filter by Status: 401 Unauthorized OR 403 Forbidden
2. Review source IPs
3. Identify unauthorized access attempts
4. Block malicious IPs
5. Export logs for security review

​

Use Case 4: Client Verification

1. Filter by Client: client-name
2. Filter by Time: Expected time window
3. Check if requests appear
4. If yes: Check status codes, errors
5. If no: Client not sending to correct URL/route

​

Use Case 5: Secret Usage Audit

1. Navigate to Secret detail page
2. Click “View Logs” or “Usage”
3. See all requests that injected this secret
4. Verify expected routes only

​

Advanced Filtering

​

Combining Filters

Status: 5xx Server Error
Latency: Min 1000ms
Route: stripe-payments
Time: Last 24 hours

​

Search Operators

/api/users

timeout
connection refused

user_id=12345

​

Exporting Logs

​

CSV Export (Pro/Enterprise Only)

• Timestamp
• Method
• Path
• Status Code
• Client name
• Source IP
• Latency (ms)
• Error message (if any)

1. Apply filters to select logs
2. Click Export button
3. CSV downloads automatically

api-logs-{tenant-slug}-{timestamp}.csv

api-logs-DunderMifflin-1705326645000.csv

​

Use Cases for Export

• Export last 90 days
• Provide to auditors
• Demonstrate API usage

• Import to Excel/Google Sheets
• Create pivot tables
• Generate custom reports

• Export monthly logs
• Store in secure location
• Maintain historical record beyond retention period

​

Pagination

• Next/Previous buttons
• Jump to page dropdown
• Total count displayed

• Indexed queries (fast even with millions of logs)
• Lazy loading (only fetch current page)

​

Retention Policies

• Logs automatically deleted
• Export before expiration if needed
• Upgrade plan for longer retention

​

Deep Links

• Alert triggers → View triggering requests

• Click chart → Drill down to specific time period

• View logs for specific route

• View logs from specific client

• View requests using secret

​

Timezone Handling

• Your configured timezone (Settings → Profile)
• Default: UTC

2025-01-15 10:30:45 EST

• Date
• Time (24-hour format)
• Timezone abbreviation

​

Troubleshooting

​

Issue: “No logs displayed”

• No requests in time range
• Filters too restrictive
• Logs expired (past retention period)

1. Clear all filters
2. Expand time range
3. Check if route is active

​

Issue: “Can’t export logs”

​

Issue: “Missing request details”

• Headers: All
• Body: First 10KB
• Response: First 10KB

​

Issue: “Logs show wrong timezone”

1. Navigate to Settings → Profile
2. Update timezone
3. Logs update automatically

​

Best Practices

​

1. Regular Log Reviews

• Review error logs (4xx, 5xx)
• Identify patterns
• Fix recurring issues

​

2. Export for Long-Term Storage

• Export last 30 days
• Archive to secure storage
• Maintain audit trail

​

3. Use Filters to Reduce Noise

• Filter out successful requests (when debugging)
• Filter specific routes (when investigating)
• Use latency filters (performance analysis)

​

4. Combine with Alerts

1. Alert fires (e.g., high error rate)
2. Click “View Logs” from alert
3. See filtered logs that triggered alert
4. Investigate root cause

​

5. Monitor Unauthorized Attempts

• Weekly review of 401/403 errors
• Identify patterns (IP ranges, times)
• Block malicious actors
• Alert on unusual activity

​

Related Features

• Alerts: Set up alerts based on log patterns
• Analytics: Aggregate log data into metrics
• Audit Logs: Track configuration changes (separate from API logs)

​

Next Steps