[activemq-artemis] branch master updated: NO-JIRA Add a note about the `jms-client-id` session metadata to the docs

[cl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

clebertsuconic pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git


The following commit(s) were added to refs/heads/master by this push:
     new 5dc038b  NO-JIRA Add a note about the `jms-client-id` session metadata to the docs
     new 3cd5efd  This closes #3451
5dc038b is described below

commit 5dc038b537ec520780f0fea3f632bda3c18d93ff
Author: Jan Šmucr <ja...@aimtec.cz>
AuthorDate: Thu Feb 11 10:48:43 2021 +0100

    NO-JIRA Add a note about the `jms-client-id` session metadata to the docs
---
 docs/user-manual/en/core.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/user-manual/en/core.md b/docs/user-manual/en/core.md
index 84ccc48..35d2697 100644
--- a/docs/user-manual/en/core.md
+++ b/docs/user-manual/en/core.md
@@ -159,6 +159,19 @@ end asynchronous systems which is not possible using the standard JMS API. For
 more information on this advanced feature please see the section [Guarantees of
 sends and commits](send-guarantees.md).
 
+###Identifying your session for management and debugging
+
+Assigning IDs to your core sessions can help you with monitoring and debugging the cluster using the [management console](management-console.md).
+```java
+ ClientSession session;
+ // ...
+ session.addMetaData(ClientSession.JMS_SESSION_IDENTIFIER_PROPERTY, "jms-client-id");
+ session.addMetaData("jms-client-id", "my-session");
+ ```
+Such ID will then appear in the **Client ID** column under the **Connections**, **Consumers** and **Producers** tabs.
+
+If you are using the JMS API, the ``setClientID`` would give you the same effect.
+
 ### ClientConsumer
 
 Clients use `ClientConsumer` instances to consume messages from a queue. Core