@shwstppr That is something that I can add. Maybe this is something that we can discuss (on the mailing list or a Github issue) in order to find conventions that best fit CloudStack log messages.

Nowadays we do not have any convention.

Hey @shwstppr what do you suggest?

I totally agree with @GabrielBrascher, normally when we are talking about a host we use their names to refer to it, I never met someone who uses UUID for this purpose.
Maybe, in some cases, the UUID turn easy to find these hosts on the database, but with a simple change on the query, we have the same result.
And for me, something like

Operation Failed vm's original host: node23.clusterA (ID: 98c37930-599f-11eb-ae93-0242ac130002) new host: node09.clusterA (ID: bdb22ea8-599f-11eb-ae93-0242ac130002) host before state transition: node01.clusterA (ID: bdb22598-599f-11eb-ae93-0242ac130002)

it is too verbose and does not add anything to the debug factor.
Presenting only the hostname in the log makes it easy to identify, as it is the way we use it to reference it daily. And with the name, we can find the UUID if necessary.
Don't you agree?

@RodrigoDLopez Hi, I don't have any issue in using just the names of host if we have consensus on that.
I liked the idea of having a discussion on ML as that will allow forming a convention project wide

@GabrielBrascher can we use something like host-name(ID: host_uuid)? Personally I found it easier at times to debug issues with uuid in logs

@blueorangutan package

But this will display uuid to users also right which doesnt make sense to them

@ravening a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

Packaging result: ✔centos7 ✔centos8 ✔debian. JID-2553

@GabrielBrascher can we use something like host-name(ID: host_uuid)? Personally I found it easier at times to debug issues with uuid in logs
@blueorangutan package

But this will display uuid to users also right which doesnt make sense to them

For logging (and debugging), I think it is better to use either ID / UUID (with/without name) as the name is not unique (multiple hosts can have the same name, across the cloudstack env).

What about adding all of them? I mean, ID, Name, and UUID. This would for sure help debugging. It would have the ID of the DB already there, and the UUID of the element that is used in the API. Moreover, the name to make the log entry more friendly.

Something such as:

s_logger.debug(String.format("Create ClusteredDirectAgentAttache for host [id=%s, uuid=%s, name=%s] ",  host.getId(), host.getUuid(), host.getName()));

@rafaelweingartner @sureshanaparti having ID, UUID, and the name sounds like a good way. Might be a bit verbose, but it serves well all the preferences.

Applied changes in order to use the toString() method from HostVO. These changes consider the proposal from PR #4706 where toString() would present a "JSON like" String.

• How it is today: Host[-123-Routing] (yep ... nowadays logs that use the toString have - before the ID)
• Proposal from Improve logs on KVMHostActivityChecker #4706: Host [{id: "123", name: "hostName", uuid: "1e374e50-g231-4345-d6h3-123abcdrfas143", type="Routing"}]

The idea is that it would be good for:

1. Debug via DB filtering with the host ID
2. Run commands on API/cloudmonkey by copying the uuid presented at the log
3. Identify the host quickly as name makes logs human-friendly
4. Name also tends to be resolved to the host address; therefore, admins can jump into the host (SSH) by copying the name from the log.

Ping for discussion/review: @rafaelweingartner @sureshanaparti @shwstppr @RodrigoDLopez @DaanHoogland @rhtyd @wido @ustcweizhou @svenvogel @andrijapanicsb and others ...

@GabrielBrascher it would be good to add host name in the output.

ip is not very important as we normally ssh into server using hostname, not ip.

diff --git a/engine/schema/src/main/java/com/cloud/host/HostVO.java b/engine/schema/src/main/java/com/cloud/host/HostVO.java
index 1c3d7c4267..a78b940142 100644
--- a/engine/schema/src/main/java/com/cloud/host/HostVO.java
+++ b/engine/schema/src/main/java/com/cloud/host/HostVO.java
@@ -677,7 +677,7 @@ public class HostVO implements Host {

     @Override
     public String toString() {
-        return new StringBuilder("Host[").append("-").append(id).append("-").append(type).append("]").toString();
+        return new StringBuilder("Host[").append(name).append("-").append(id).append("-").append(type).append("]").toString();
     }

     public void setHypervisorType(HypervisorType hypervisorType) {

@weizhouapache Sorry if I was not clear, but PR #4706 is adding the host's name indeed, IP address would not be interesting indeed.

The idea is exactly what you mentioned. We will then log host ID, UUID, and Name (Type will also be logged the host.toString is used for non-routing hosts as well).

This PR also uses the toString in order to have a standard Host log. As PR #4706 already proposes an interesting approach, I added it on this proposal as well.

@blueorangutan package

@blueorangutan package

@GabrielBrascher a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

@blueorangutan package

@nvazquez a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

Packaging result: ✔️ centos7 ✔️ centos8 ✔️ debian. SL-JID 442

@blueorangutan test

@nvazquez a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

Trillian test result (tid-1188)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 58897 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr4575-t1188-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_kubernetes_clusters.py
Intermittent failure detected: /marvin/tests/smoke/test_privategw_acl.py
Intermittent failure detected: /marvin/tests/smoke/test_storage_policy.py
Intermittent failure detected: /marvin/tests/smoke/test_templates.py
Intermittent failure detected: /marvin/tests/smoke/test_usage.py
Intermittent failure detected: /marvin/tests/smoke/test_vm_life_cycle.py
Intermittent failure detected: /marvin/tests/smoke/test_volumes.py
Intermittent failure detected: /marvin/tests/smoke/test_vpc_redundant.py
Intermittent failure detected: /marvin/tests/smoke/test_vpc_router_nics.py
Smoke tests completed. 81 look OK, 7 have error(s)
Only failed tests results shown below:

Packaging result: ✔️ el7 ✔️ el8 ✔️ debian. SL-JID 457

Trillian test result (tid-1194)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 33154 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr4575-t1194-kvm-centos7.zip
Smoke tests completed. 88 look OK, 0 have error(s)
Only failed tests results shown below:

@blueorangutan package

@nvazquez a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

@blueorangutan package

@nvazquez a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

Packaging result: ✔️ el7 ✔️ el8 ✖️ debian. SL-JID 522

Packaging result: ✔️ el7 ✔️ el8 ✔️ debian. SL-JID 523

@blueorangutan test

@nvazquez a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

Trillian Build Failed (tid-1237)

@blueorangutan test

@nvazquez a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

Trillian test result (tid-1238)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 42963 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr4575-t1238-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_diagnostics.py
Intermittent failure detected: /marvin/tests/smoke/test_routers_network_ops.py
Intermittent failure detected: /marvin/tests/smoke/test_vpc_redundant.py
Intermittent failure detected: /marvin/tests/smoke/test_vpc_vpn.py
Intermittent failure detected: /marvin/tests/smoke/test_host_maintenance.py
Smoke tests completed. 87 look OK, 1 have error(s)
Only failed tests results shown below:

Merging based on approvals and test results