Linkcheck CI job fails intermittently due to rate-limiting on dochub.mongodb.org

XMLWordPrintableJSON

    • None
    • Python Drivers
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      The Link Check CI job intermittently fails with a 30-second read timeout when checking dochub.mongodb.org links.

      Example failure from this CI run:

        (api/bson/objectid: line 29) timeout   http://dochub.mongodb.org/core/objectids -
        HTTPSConnectionPool(host='dochub.mongodb.org', port=443): Read timed out. (read timeout=30)
        

      The default Sphinx linkcheck configuration fires 5 concurrent workers, which causes the dochub redirect service to drop connections.

      Fix: In doc/conf.py, set linkcheck_workers = 1 to serialize requests to the same host, and increase linkcheck_timeout = 60 to give slow redirects more room before retrying.

      Definition of done

      Make the configuration changes and run the link check job a few times.

      Pitfalls

      N/A

            Assignee:
            Steve Silvester
            Reporter:
            Steve Silvester
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: