Uploaded image for project: 'Traffic Server'
  1. Traffic Server
  2. TS-2354

improve documentation about different type of timeouts

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Done
    • None
    • Docs
    • Documentation
    • None

    Description

      Traffic Server provides different types of timeouts:

      • dns
      • connect
      • no activity
      • active

      I found no documentation about the timeouts, specially no activity and active.

      Attachments

        Issue Links

          Activity

            jsime Jon Sime added a comment -

            All timeouts are now documented in the Administrator's Guide, with cross-referencing in the records.config documentation.

            jsime Jon Sime added a comment - All timeouts are now documented in the Administrator's Guide, with cross-referencing in the records.config documentation.

            Commit c6afd5443852789c82e024cd61e44c4fabbfd1ac in trafficserver's branch refs/heads/master from jsime
            [ https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;h=c6afd54 ]

            TS-2354: docs: admin tuning section on all available timeouts

            jira-bot ASF subversion and git services added a comment - Commit c6afd5443852789c82e024cd61e44c4fabbfd1ac in trafficserver's branch refs/heads/master from jsime [ https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;h=c6afd54 ] TS-2354 : docs: admin tuning section on all available timeouts
            oknet Chao Xu added a comment -

            Referer to the comments in iocore/net/I_NetVConnection.h:

            /**
            在状态机使用此NetVC一定时间之后,会收到VC_EVENT_ACTIVE_TIMEOUT事件。
            如果读、写都未在此NetVC激活,那么此值会被忽略。
            这个功能防止状态机较长时间的保持连接的打开状态。

            Sets time after which SM should be notified.
            Sets the amount of time (in nanoseconds) after which the state
            machine using the NetVConnection should receive a
            VC_EVENT_ACTIVE_TIMEOUT event. The timeout is value is ignored
            if neither the read side nor the write side of the connection
            is currently active. The timer is reset if the function is
            called repeatedly This call can be used by SMs to make sure
            that it does not keep any connections open for a really long
            time.
            ...
            */
            virtual void set_active_timeout(ink_hrtime timeout_in) = 0;

            /**
            当状态机请求在此NetVC执行的IO操作没有完成时,
            在读写都处于IDLE状态一定时间之后,状态机会收到VC_EVENT_INACTIVITY_TIMEOUT事件
            任何读写操作的发生,都会导致计时器被重置。
            如果读、写都未在此NetVC激活,那么此值会被忽略。

            Sets time after which SM should be notified if the requested
            IO could not be performed. Sets the amount of time (in nanoseconds),
            if the NetVConnection is idle on both the read or write side,
            after which the state machine using the NetVConnection should
            receive a VC_EVENT_INACTIVITY_TIMEOUT event. Either read or
            write traffic will cause timer to be reset. Calling this function
            again also resets the timer. The timeout is value is ignored
            if neither the read side nor the write side of the connection
            is currently active. See section on timeout semantics above.
            */
            virtual void set_inactivity_timeout(ink_hrtime timeout_in) = 0;

            I think that :
            Active Timeout means a NetVC life cycle time, after which the SM using the NetVConnection should close the NetVC to avoid connection flood attack.
            Inactivity Timeout means a NetVC max idle time, that implement a traditional timeout control, for example: connect to a remote server by non-block mode.

            oknet Chao Xu added a comment - Referer to the comments in iocore/net/I_NetVConnection.h: /** 在状态机使用此NetVC一定时间之后,会收到VC_EVENT_ACTIVE_TIMEOUT事件。 如果读、写都未在此NetVC激活,那么此值会被忽略。 这个功能防止状态机较长时间的保持连接的打开状态。 Sets time after which SM should be notified. Sets the amount of time (in nanoseconds) after which the state machine using the NetVConnection should receive a VC_EVENT_ACTIVE_TIMEOUT event. The timeout is value is ignored if neither the read side nor the write side of the connection is currently active. The timer is reset if the function is called repeatedly This call can be used by SMs to make sure that it does not keep any connections open for a really long time. ... */ virtual void set_active_timeout(ink_hrtime timeout_in) = 0; /** 当状态机请求在此NetVC执行的IO操作没有完成时, 在读写都处于IDLE状态一定时间之后,状态机会收到VC_EVENT_INACTIVITY_TIMEOUT事件 任何读写操作的发生,都会导致计时器被重置。 如果读、写都未在此NetVC激活,那么此值会被忽略。 Sets time after which SM should be notified if the requested IO could not be performed. Sets the amount of time (in nanoseconds), if the NetVConnection is idle on both the read or write side, after which the state machine using the NetVConnection should receive a VC_EVENT_INACTIVITY_TIMEOUT event. Either read or write traffic will cause timer to be reset. Calling this function again also resets the timer. The timeout is value is ignored if neither the read side nor the write side of the connection is currently active. See section on timeout semantics above. */ virtual void set_inactivity_timeout(ink_hrtime timeout_in) = 0; I think that : Active Timeout means a NetVC life cycle time, after which the SM using the NetVConnection should close the NetVC to avoid connection flood attack. Inactivity Timeout means a NetVC max idle time, that implement a traditional timeout control, for example: connect to a remote server by non-block mode.
            psudaemon Phil Sorber added a comment -

            bcall has some related slides from the recent summit in Austin.

            psudaemon Phil Sorber added a comment - bcall has some related slides from the recent summit in Austin.

            People

              jsime Jon Sime
              dmorilha Daniel Vitor Morilha
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: