Troubleshooting
This guide covers common issues and troubleshooting steps for Supaship.
Common Issues
- Feature flag not working
- Feature changes not reflecting
- API key issues
- Context object issues
- Edge cases with targeting rules
- Performance issues
- Error messages
General Troubleshooting Steps
- Verify your API key is correct (32 characters, and a suffix of
-client
or-server
). - Check that the feature flag name matches exactly (case-sensitive).
- Ensure the SDK is properly initialized.
- Verify the feature is enabled (on) in the correct environment.
- Check if targeting rules are preventing the flag from being evaluated.
Context Object Issues
Problem: Context object is not properly configured
Solutions:
- Verify the context object contains required properties (userID, email, etc.).
- Check for any missing properties in the context object.
- Ensure the context object is properly serialized.
Edge Cases with Targeting Rules
Problem: Edge cases with targeting rules are not working
Solutions:
- Verify the targeting rules are properly configured.
- Check for any missing targeting rules.
- Ensure the targeting rules are properly serialized.
Feature Flag Not Working
- Verify your API key is correct (32 characters, no prefixes)
- Check that the feature flag name matches exactly (case-sensitive)
- Ensure the SDK is properly initialized
- Verify the feature is enabled in the correct environment
- Check if targeting rules are preventing the flag from being enabled
Feature Changes Not Reflecting
Problem: Feature flag changes don’t appear immediately
Solutions:
- Wait a few seconds for propagation.
- Verify the feature targeting rules are properly configured in the right environment.
- Try refreshing the page or clearing cache.
API Key Issues
Problem: “Invalid API key” or “Unauthorized” errors
Solutions:
- Ensure the API key is exactly 32 characters and has a suffix of
-client
or-server
. - Remove any prefixes or extra whitespace.
- Copy the key from the API Keys section of project settings.
- Use Client Key for frontend apps, Server Key for backend services.
- Verify the key belongs to the correct project.
Last updated on