Orchestrator GUI messages should optionally contain the name of the orchestratorapp generating the message

Description

If you use orchestrator and the GUI then you may want to do operations like relocate servers or perform other actions. Orchestrator gives you feedback in the GUI with a message at the top of the screen.

Orchestrator can be configured to run with multiple apps in parallel to allow for HA and with a load balancer in front of these apps you can not determine which app you are talking to. It does not usually matter as the page looks the same and it is also convenient to do maintenance on the application servers and the user is unaffected.

However, some error messages may appear and in these cases it is not possible to identify which of the orchestratorapp servers behind the load balancer is actually generating the messages that you see in the GUI.

Consequently I think it would be useful to have an option in orchestrator to prefix the messages with the orchestrator apps' identity, maybe the FQDN or if not the short name.

This allows you to see where the message came from and also be able to see if it comes from the same app.

I include a small image where an error was seen and while I can go onto the app servers and grep the logs to find this it's much easier if I can just see where this happened. The error was triggered when trying to relocate a server and after a few attempts the relocation succeeded.

Environment

None

AFFECTED CS IDs

CS0030876

Attachments

5

Smart Checklist

Activity

Show:

Simon Mudd June 13, 2023 at 4:43 PM

Thanks.

Kamil Holubicki June 6, 2023 at 1:41 PM

Kamil Holubicki June 6, 2023 at 12:31 PM
Edited

I've added two configuration options:

PrependMessagesWithOrcIdentity

Allowed values:

empty string (default) or 'none' - no prefixing

FQDN - fully qualified domain name of the server will be used with the fallback to 'hostname' behavior if FQDN cannot be obtained

hostname - hostname will be used with fallback to 'custom' if CustomOrcIdentity is not empty

custom - the value provided in CustomOrcIdentity option will be used

CustomOrcIdentity

Allowed values:

Any string identifying the Orchastrator instance. It is used together with PrependMessagesWithOrcIdentity=custom or as a fallback to FQDN and hostname.

 

Examples:

 

PrependMessagesWithOrcIdentity none/empty string/config key omitted:

This is the default/old behavior

FQDN:

config file:

hostname:

config file:

custom:

config file:

Yves Trudeau May 30, 2023 at 6:18 PM

Hi Simon,

   I am just wondering, is it because when you go to "Home -> Status", the load balancer may send you to another host?

 

 

Simon Mudd October 13, 2022 at 6:47 AM

Missing from my report was the orchestrator version affected by this:

Done

Details

Assignee

Reporter

Needs Review

Yes

Needs QA

Yes

Components

Fix versions

Priority

Smart Checklist

Created October 11, 2022 at 4:57 PM
Updated October 30, 2024 at 11:33 AM
Resolved September 19, 2023 at 7:29 PM