Request Logs

​

Overview

​

Log Information

​

Viewing Logs

​

Dashboard

1. Navigate to Logs
2. View the log stream
3. Click on any entry for details

​

Filtering

​

Search

• Request ID
• Entity name
• Error message
• Path

​

Log Details

{
  "requestId": "req_abc123def456",
  "timestamp": "2024-01-15T10:30:45.123Z",
  "apiKey": {
    "id": "key_xyz789",
    "name": "Backend Service",
    "prefix": "sk_live_abc1"
  },
  "request": {
    "method": "GET",
    "path": "/sap/opu/odata/sap/API_BUSINESS_PARTNER/A_BusinessPartner",
    "query": {
      "$top": "10",
      "$filter": "BusinessPartnerCategory eq '1'"
    }
  },
  "response": {
    "status": 200,
    "size": 15234,
    "recordCount": 10
  },
  "timing": {
    "total": 245,
    "sap": 198,
    "proxy": 47
  },
  "instance": {
    "id": "inst_abc",
    "name": "Production",
    "alias": "production"
  },
  "entity": "A_BusinessPartner",
  "operation": "list"
}

​

Error Tracking

​

Error Logs

1. Set Status filter to “Error”
2. View failed requests
3. Check error details

​

Error Information

{
  "error": {
    "code": "ODATA_ERROR",
    "message": "Resource not found",
    "sapErrorCode": "005",
    "sapMessage": "Business Partner 99999999 does not exist"
  }
}

​

Common Errors

​

Performance Monitoring

​

Response Times

• Total Time: End-to-end request duration
• SAP Time: Time spent in SAP
• Proxy Time: S4Kit overhead

​

Identifying Slow Requests

1. Sort by response time
2. Look for patterns:
   • Specific entities
   • Large result sets
   • Complex filters

​

Optimization Tips

• Use $select to limit fields
• Add $top to limit results
• Optimize $filter expressions
• Use pagination instead of fetching all

​

Log Retention

​

Retention Period

​

Exporting Logs

1. Set your filters
2. Click Export
3. Choose format (JSON, CSV)
4. Download the file

​

Using Request IDs

​

In SDK Errors

try {
  await client.A_BusinessPartner.list();
} catch (error) {
  console.error('Request failed:', error.requestId);
  // Use this ID when contacting support
}

​

In Support Requests

1. Note the request ID
2. Include timestamp
3. Describe expected vs actual behavior
4. Share the request ID with support

​

Webhooks (Coming Soon)

• SIEM integration
• Custom monitoring
• Alert systems

​

Best Practices

​

Regular Review

• Check error rates daily
• Monitor response times
• Look for unusual patterns

​

Alerting

• Error rate spikes
• Response time degradation
• Rate limit hits

​

Compliance

• Export logs regularly
• Store exports securely
• Document retention policies