Enable and View Audit Logs in Tyk Developer Portal

​

Availability

​

Prerequisites

1. License: Contact our team to obtain a license or get a self-managed trial license by completing the registration on our website.
2. Working Tyk Environment: You need access to a running Tyk instance. For quick setup instructions using Docker, please refer to the Tyk Getting Started Guide.
3. Admin Access: You need admin permissions to configure audit logging in the Portal.

​

What We Will Do

1. Enable audit logs in the Tyk Developer Portal using the file storage option
2. Configure the log file path and format
3. View the audit logs from the log file

​

Instructions

​

1. Configure Audit Logging

PORTAL_AUDIT_LOG_ENABLE=true
PORTAL_AUDIT_LOG_PATH=/var/log/portal

{
  "AuditLog": {
    "Enable": true,
    "Path": "/var/log/portal"
  }
}

​

2. Restart the Developer Portal

# For Docker
docker restart tyk-portal

# For Docker Compose
docker compose restart tyk-portal

# For Kubernetes
kubectl rollout restart deployment tyk-portal -n tyk

​

3. View Audit Logs

​

Access the Log File

# View the audit log file
cat /var/log/portal/portal.log

# Follow the log file in real-time
tail -f /var/log/portal/portal.log

# Search for specific actions
grep "admin@example.com" /var/log/portal/portal.log

​

For Docker Containers

# Access logs from a running container
docker exec -it tyk-portal cat /var/log/portal/portal.log

​

For Kubernetes

# Access logs from a running pod
kubectl exec -it deployment/tyk-portal -n tyk -- cat /var/log/portal/portal.log

​

Troubleshooting

# Check if the directory exists
ls -la /var/log/portal/

# Check Portal container logs
docker logs tyk-portal 2>&1 | grep -i audit