Skip to main content

User count

The following explains how to count the number of users connected to the Java web application server through agent settings. It includes the setting whether to enable real-time user counting, setting of the cookie limit to count users, the method how to count users based on the IP address or specific HTTP header values, and setting of HTTP headers to trace client IPs.

  • trace_user_enabled Boolean

    Default true

    Set whether or not to aggregate real-time users. If the user tracing option setting is duplicated, the action priority is as follows.

    1. trace_user_using_ip / wclient_using_ip
    2. trace_user_using_jsession
    3. user_header_ticket / wclient_header_ticket
    Note

    In case of Java Agent 2.2.0 or later, use the wclient_using_ip and wclient_header_ticket options.

  • trace_user_cookie_limit / wclient_cookie_limit Int

    Default 2048

    If cookies are issued for counting users, a cookie overflow may occur if there are too many cookies. To prevent this from happening, set the limit.

    Note

    In case of Java Agent or later, use the wclient_cookie_limit option.

  • trace_user_using_ip / wclient_using_ip Boolean

    Default true

    It aggregates real-time users based on the IP address. If you want to distinguish users based on the cookie rather than IP addresses, change the value to false.

    Note

    In case of Java Agent 2.2.0 or later, use the wclient_using_ip option.

  • user_header_ticket / wclient_header_ticket String

    To aggregate the numbers of users with a specific value in the HTTP header, set the key value. If headers are used to distinguish users in case of mobile clients, the following options are available.

    whatap.conf
    user_header_ticket=login
    Note

    In case of Java Agent 2.2.0 or later, use the wclient_header_ticket option.

  • trace_http_client_ip_header_key String ​

    This function sets the client IP (remote IP) with a specific HTTP header value. In the proxy environment, the X-Forwarded-For header can be set with the client IP.

    If the load balancer like L4 is located before WEB/WAS, in some cases, the IP address of L4 becomes the remote address instead of the IP address of the client. In this situation, if the actual client IP is recorded as a specific key value in the HTTP header, it can be replaced with the corresponding key value.

  • trace_user_using_jsession Boolean

    Default false

    It aggregates real-time users based on SESSIONID.