Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 5.42 KB

plugin-error-logs.md

File metadata and controls

74 lines (49 loc) · 5.42 KB
Raw

WordPress Error logs, what causes them and what do they mean.

The purpose of this document is to list all of the errors and warnings that can be displayed when using the Agora Video for WordPress plugin.

Basic Setup Errors

  1. "Please configure your Agora App ID before use this shortcode"
    This error is dispalyed when the app id is not properly configured within the plugin's settings page. If this value was set but it fails to save, this is an indication of a plugin conflict.

  2. "Please define the channel_id attribute to use on this shortcode"
    This error is dispalyed when the channel id is not properly configured within the plugin's shorcode that is embedded the page. To troublshoot, make sure to copy the entire shortcode from the Agora Channels page.

  3. Plugin Conflict
    In the event of a plugin conflict, user's should disable all plugins except for the Agora Video for WordPress plugin. Once all other plugins are deactivate, save your Agora credentials and then re-activate the other plugins.

Javascript Errors and Warnings

  1. "[ERROR] : AgoraRTC client init failed"
    This error is thrown when the Agora RTC client fails to initialize.

  2. "Live streaming failed"
    This message is displayed when the live streaming fails.

  3. "Agora Exception:"
    This message is displayed when exception events occur in the channel. Exceptions are not errors, but usually mean quality issues. This callback also reports recovery from an exception. Each exception event has a corresponding recovery event, see the table below for details: Excepction Events > Note: this callback is currently only supported by the Chrome Browser.

  4. "Stream undefined cannot be removed"
    This is warning that is displayed when an error occurs within the 'peer-leave' event. As a safety, the function checks that the event passed into the callback is a non null value and contains a stream with a non null value. If either the event or the stream values are null, a warning will be displayed in the logs and the function will return without completing any other steps.

  5. Any log event follow "Starting rec..."
    These errors occur because of an issue with the starting of the cloud recording service. Please refere to the Common Errors section of the offical Agora.io Cloud Recording documentation.

  6. Any log event following "Stoping rec..."
    These errors occur because of an issue with the stopping of the cloud recording service. Please refer to the Common Errors section of the official Agora.io Cloud Recording documentation.

  7. Any log event prefixed "API Error:"
    These errors occur because of an issue with the querying of the cloud recording service. Please refer to the Common Errors section of the offical Agora.io Cloud Recording documentation.

  8. Any log event prefixed: "Avatar not available:"
    This warning log is displayed when there is an error retrieving the user's Gravatar from the user's WordPress profile.

PHP Errors and Warnings

Cloud Recording

  1. "Invalid SDK Parameters!"
    This error occurs when the WP client sends a malformed request to generate a POST request for Cloud Recording functionality. For some reason the request received by the backend does not set valid values within the sdk_action parameters of the request.

  2. "SDK Action not defined!"
    This error occurs when the WP client sends a malformed request to generate a POST request for Cloud Recording functionality. In this instance the desired cloud recording action is within the expected list of actions. Expected "actions" are start-recording, query-recording and stop-recording.

  3. "Incomplete data"
    This error occurs when the WP client sends a malformed request to generate a POST request for Cloud Recording functionality. In this instance the recordingId is missing from the input parameters.

  4. "Storage Config not finished."
    This error occurs when the WP client sends a request to start Cloud Recording but the administrator has not properly configured the storage bucket within the Channel settings.

  5. "No response from server"
    This error occurs when the WP client sends a request to the Agora Cloud Recording service but the Cloud Recording server fails to respond.

Token Errors

  1. "Token Server not configured!"
    This error occurs when the WP client attempts to generate a token but the administrator has not properly configured the app certificate within the plugin's settings page.

  2. "404 Channel Not Found", "Undefined channel!", or '"Channel not found"
    This error is displayed when the plugin attempts to generate a token using the token server functionality but there is an issue with the channel name.

  3. Any messge ending in " check failed, should be a non-empty string"
    When the plugin attempts any token related functionality it first checks to ensure appID, appCertificate, channelName, and token are not empty values.

  4. "invalid version "
    When the plugin attempts any token related functionality it first checks to ensure the token version is valid.