Bug 6124 - The load balancer "users" quantity is confusing
Summary: The load balancer "users" quantity is confusing
Status: CLOSED FIXED
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: 4.18.0
Assignee: Emelie
URL:
Keywords: aleze_tester, prosaic, tobfa_tester
Depends on:
Blocks:
 
Reported: 2017-01-09 12:29 CET by Karl Mikaelsson
Modified: 2024-11-05 16:14 CET (History)
4 users (show)

See Also:
Acceptance Criteria:
MUST: * What contributes to the "users" quantity must be clear in tlwebadm and tlctl * The load balancer must make sense from the tlwebadm and tlctl load information overview SHOULD: * ThinLinc users should be distinguishable from real+system users in tlwebadm and tlctl * Agent user limits should connect clearly to tlwebadm and tlctl load information COULD: * Specify the user distinctions in documentation


Attachments

Description Karl Mikaelsson cendio 2017-01-09 12:29:54 CET
The "ThinLinc Agent Servers" table in tlwebadm seems to be a copy of data straight from the load balancer, without explanation nor documentation.

It's for example impossible for an administrator to know that the "Users" field is not a measure of the number of users using ThinLinc Sessions, but the number of unique UIDs running stuff on the machine. It's hard to remember for us developers too, but at least we can follow the code.
Comment 3 Samuel Mannehed cendio 2023-02-04 15:02:34 CET
The columns available on the Load page in recent builds of Web Admin are less confusing.

However, the "Users" column is still confusing in the same way as before. To be consistent, we made the decision to show the same number in `tlclt load list`. So, this bug is also valid for tlctl.

The consensus in internal discussions is that we aren't really concerned about non-thinlinc users here. However, as long as the load balancer takes these users into account, we should display that number.

Unless the load balancer changes, we can try to solve this confusion using better documentation. Note that the following is written in the man pages for tlctl load:

> USERS  Total numbers of users, accounting for system and ThinLinc users.
Comment 4 Tobias cendio 2024-10-22 17:32:18 CEST
There are several types of users composing the users quantity used in the load
balancer. They consist of ThinLinc users, real users (local and remote), and
system users.

Different stakeholders may value these components differently. For instance, the
ThinLinc load balancer takes into account the total number of users, a sysadmin
may value the number of real users when assessing systems, and finally, a
ThinLinc admin may be interested in the number of active users pertaining to the
remaining allowed agent user slots (see bug 284).

The users quantity presented in our tools tlwebadm and tlctl should be stated
more clearly, and perhaps separated into its different components to the extent
it is possible. However, since we won't be modifying the inner workings of the
load balancer by virtue of the scope of this bug, the style of presentation
should probably preserve the interpretation of the actions taken by the load
balancer.

Based on this, it makes sense that the users quantity presented in the tlwebadm
and tlctl load overviews should be the total number of users, and the different
components presented in the detailed views.
Comment 6 Emelie cendio 2024-10-25 16:56:11 CEST
This issue has been fixed according to comment 4. We added ThinLinc users to the detailed overviews in Web Admin and "tlctl load show".

> MUST:
> ✅ What contributes to the "users" quantity must be clear in tlwebadm and tlctl
Yes, we made the total number of users more clear, both in the label and by adding a descriptive text.

> ✅ The load balancer must make sense from the tlwebadm and tlctl load
>    information overview
Yes, the user number in the overview wasn't modified, so this holds.

> SHOULD:
> ✅ ThinLinc users should be distinguishable from real+system users in
>    tlwebadm and tlctl
Yes, they are two different rows.

> ✅ Agent user limits should connect clearly to tlwebadm and tlctl load
>    information
Yes, by looking at the details of the load for one of the agents, the admin can see the number of ThinLinc users.

> COULD:
> ☑️ Specify the user distinctions in documentation
Documentation for the man page and TAG is done for tlctl. Regarding webadmin, there is no documentation for the load page, will be fixed in bug 8128.
Comment 7 Tobias cendio 2024-10-28 14:49:18 CET
General
-------------------
Tested this bug using server build #3758.

The new load information is showing up as intended in both tlwebadm and tlctl
load modules. What's presented in the less detailed load overview hasn't changed
-- only the detailed view has received additional information where, next to the
newly branded "Total number of users", "ThinLinc users" are now displayed. As a
result, admins are not required to update how they relate this information to
the load balancer. Furthermore, the users information can now readily be
leveraged in combination with the agent user limits.

Next to the ThinLinc users number, the number of sessions is now displayed in
parenthesis. While this is somewhat relevant to agent load status, it undermines
the general effort to keep modules and tools orthogonal in their
functionality. This information is after all available in the parallel sessions
module and just adds to the testing landscape.

In tlwebadm, additional explanatory text was added in an effort to clarify what
the Users column is displaying. The paragraph reads a bit strange now with the
repetition of "Click on an agent...". Perhaps it could either benefit from its own
paragraph, or the repetitions are combined into one sentence, or one of the
repetitions are rephrased.

Concerning the description on the tlctl load man page for total users, maybe it
should be reworded more in line with the ThinLinc and non-ThinLinc users
distinction, like in tlwebadm.

Had a look at the code and things appear to be properly implemented along with
updated unittests!

Acceptance criteria
-------------------

> MUST:
> * What contributes to the "users" quantity must be clear in tlwebadm and tlctl
  ✅ This quantity should not be confusing now with the additional descriptions
     and the "ThinLinc users" separate quantity.

> * The load balancer must make sense from the tlwebadm and tlctl load information overview
  ✅ This aspect is unchanged.

> SHOULD:
> * ThinLinc users should be distinguishable from real+system users in tlwebadm and tlctl
  ✅ They are.

> * Agent user limits should connect clearly to tlwebadm and tlctl load information
  ✅ This information is now readily found in the detailed view.

> COULD:
> * Specify the user distinctions in documentation
  ❌ This is partly done. The tlctl load man page is updated but a more lengthy
     explanation is missing in the TAG since before -- see bug 8128.

Conclusion
-------------------
Reopening to address the concerns raised above in the General section.
Comment 10 Tobias cendio 2024-10-29 16:20:26 CET
Issues in the documentation mentioned in comment 7 have been fixed.

Closing.
Comment 11 Alexander Zeijlon cendio 2024-11-01 08:50:57 CET
Reopen after some comments over email.

Note You need to log in before you can comment on or make changes to this bug.