support Contact Support | system status System Status

Creating a Charles Log

In this topic, you will learn how to create and save a Charles log. This can be helpful when working with support, and they may ask you to send the log to them.

Charles is a web proxy that runs on your computer and allows you to record data that is sent and received between your web browser and the server. Using Charles makes it easy to diagnose and fix problems. For details, see the Charles web proxy site.

Steps to create a Charles log

The following steps lead you through using the Charles web proxy to create a recorded log.

  1. Download and install Charles on your machine. Charles is compatible with Windows, Mac and Linux. For platform specific details about installing Charles, see the Charles Installation notes.

  2. On your computer, run Charles. From the menu, select Proxy > Proxy Settings. Ensure a port has been assigned (e.g., 8888) and the Enable transparent HTTP proxying option is selected.
    Proxy settings
    Proxy settings
  3. Select OK to save changes and close the dialog.
  4. Install the Charles SSL certificate. From the menu, select Help > SSL Proxying > Install Charles Root Certificate.
    Install Charles SSL certificate
    Install Charles SSL certificate
  5. In the Add Certificate dialog, select Add.
    Add Charles SSL certificate
    Add Charles SSL certificate
  6. Keychain Access will open. From the certificate list, find the Charles Proxy... certificate. Double click on it to see detailed information.

    Keychain Access
    Keychain Access
  7. Expand the Trust section. For the When using this certificate option, select Always trust.
    Trust certificate
    Trust certificate
  8. Close the certificate window and enter your Admin password to update settings.
  9. Enable SSL proxying in Charles. From the menu, select Proxy > SSL Proxy Settings. Ensure the Enable SSL Proxying option is selected. In the Location section, select the Add button.
    SSL Proxy settings
    SSL Proxy settings
  10. In the Edit Location dialog, navigate to the Port field and enter 443. Select OK to save this change.
    Location port 443
    Location port 443
  11. Select OK to close the Edit Location dialog.
    SSL settings with location
    SSL settings with location
  12. Select OK to exit the SSL Proxying Settings dialog.
  13. It's recommended that you restart your computer at this point to make sure that Charles picks up the new certificate settings.
  14. Keep Charles open while you do the next steps.
  15. Paste the URL to the page that contains the Brightcove Player you are troubleshooting into the browser's address bar, and then press Enter to load the page.
  16. Run through the steps you previously used to reproduce the error or issue. Charles will automatically record what is happening.
  17. If network traffic is needed for when the player is playing a video, start the video.
  18. After reproducing the error, return to Charles. Select the Structure view and find the URL for your player.
  19. Select Stop Recording.
    Charles stop recording
    Charles stop recording
  20. Save the current session in a file.
    Charles save session
    Charles save session
  21. Email the Charles session file to the appropriate support personnel.

Add Akamai headers

In this section, you will learn how to add Akamai headers to your requests.

  1. From the main Charles window, select Tools and then Rewrite.
    Tools Rewrite
    Tools Rewrite
  2. In the Rewrite Settings dialog, select Enable Rewrite.
  3. Add a new Set called Akamai Headers.
    Add header
    Add header
  4. Add a new Rule.
    Add rule
    Add rule
  5. In the Rewrite Rule dialog, select a type of Add Header.

  6. In the Replace section, add the following:

    Name: Pragma

    Value:

          akamai-x-get-request-id, akamai-x-cache-on, akamai-x-cache-remote-on,
          akamai-x-check-cacheable, akamai-x-get-cache-key, akamai-x-get-extracted-values,
          akamai-x-get-nonces, akamai-x-get-ssl-client-session-id, akamai-x-get-true-cache-key,
          akamai-x-serial-no
    Add rule details
    Add rule details
  7. Select OK, and then OK.

Charles for mobile

To learn about capturing mobile logs with Charles, see the Debugging on Mobile Devices document.


Page last updated on 01 Apr 2020