diff --git a/collector/src/main/resources/pinpoint-collector.properties b/collector/src/main/resources/pinpoint-collector.properties index 732380371774..f0ec3ae60283 100644 --- a/collector/src/main/resources/pinpoint-collector.properties +++ b/collector/src/main/resources/pinpoint-collector.properties @@ -40,7 +40,19 @@ collector.agentEventWorker.queueSize=1024 statistics.flushPeriod=1000 -# enable cluster in socket manager. +# ------------------------------------------------------------------------------------------------- +# The cluster related options are used to establish connections between the agent, collector, and web in order to send/receive data between them in real time. +# You may enable additional features using this option (Ex : RealTime Active Thread Chart). +# ------------------------------------------------------------------------------------------------- +# Usage : Set the following options for collector/web components that reside in the same cluster in order to enable this feature. +# 1. cluster.enable (pinpoint-web.properties, pinpoint-collector.properties) - "true" to enable +# 2. cluster.zookeeper.address (pinpoint-web.properties, pinpoint-collector.properties) - address of the ZooKeeper instance that will be used to manage the cluster +# 3. cluster.web.tcp.port (pinpoint-web.properties) - any available port number (used to establish connection between web and collector) +# ------------------------------------------------------------------------------------------------- +# Please be aware of the following: +#1. If the network between web, collector, and the agents are not stable, it is advisable not to use this feature. +#2. We recommend using the cluster.web.tcp.port option. However, in cases where the collector is unable to establish connection to the web, you may reverse this and make the web establish connection to the collector. +# In this case, you must set cluster.connect.address (pinpoint-web.properties); and cluster.listen.ip, cluster.listen.port (pinpoint-collector.properties) accordingly. cluster.enable=true cluster.zookeeper.address=localhost cluster.zookeeper.sessiontimeout=30000 diff --git a/quickstart/collector/src/main/resources/pinpoint-collector.properties b/quickstart/collector/src/main/resources/pinpoint-collector.properties index 002493737284..381d6b551f5f 100644 --- a/quickstart/collector/src/main/resources/pinpoint-collector.properties +++ b/quickstart/collector/src/main/resources/pinpoint-collector.properties @@ -25,6 +25,19 @@ collector.udpSpanSocketReceiveBufferSize=4194304 statistics.flushPeriod=1000 +# ------------------------------------------------------------------------------------------------- +# The cluster related options are used to establish connections between the agent, collector, and web in order to send/receive data between them in real time. +# You may enable additional features using this option (Ex : RealTime Active Thread Chart). +# ------------------------------------------------------------------------------------------------- +# Usage : Set the following options for collector/web components that reside in the same cluster in order to enable this feature. +# 1. cluster.enable (pinpoint-web.properties, pinpoint-collector.properties) - "true" to enable +# 2. cluster.zookeeper.address (pinpoint-web.properties, pinpoint-collector.properties) - address of the ZooKeeper instance that will be used to manage the cluster +# 3. cluster.web.tcp.port (pinpoint-web.properties) - any available port number (used to establish connection between web and collector) +# ------------------------------------------------------------------------------------------------- +# Please be aware of the following: +#1. If the network between web, collector, and the agents are not stable, it is advisable not to use this feature. +#2. We recommend using the cluster.web.tcp.port option. However, in cases where the collector is unable to establish connection to the web, you may reverse this and make the web establish connection to the collector. +# In this case, you must set cluster.connect.address (pinpoint-web.properties); and cluster.listen.ip, cluster.listen.port (pinpoint-collector.properties) accordingly. cluster.enable=true cluster.zookeeper.address=localhost cluster.zookeeper.sessiontimeout=30000 diff --git a/quickstart/web/src/main/resources/pinpoint-web.properties b/quickstart/web/src/main/resources/pinpoint-web.properties index 655a51c595b6..c2d169bcbda2 100644 --- a/quickstart/web/src/main/resources/pinpoint-web.properties +++ b/quickstart/web/src/main/resources/pinpoint-web.properties @@ -1,4 +1,16 @@ -# local +# ------------------------------------------------------------------------------------------------- +# The cluster related options are used to establish connections between the agent, collector, and web in order to send/receive data between them in real time. +# You may enable additional features using this option (Ex : RealTime Active Thread Chart). +# ------------------------------------------------------------------------------------------------- +# Usage : Set the following options for collector/web components that reside in the same cluster in order to enable this feature. +# 1. cluster.enable (pinpoint-web.properties, pinpoint-collector.properties) - "true" to enable +# 2. cluster.zookeeper.address (pinpoint-web.properties, pinpoint-collector.properties) - address of the ZooKeeper instance that will be used to manage the cluster +# 3. cluster.web.tcp.port (pinpoint-web.properties) - any available port number (used to establish connection between web and collector) +# ------------------------------------------------------------------------------------------------- +# Please be aware of the following: +#1. If the network between web, collector, and the agents are not stable, it is advisable not to use this feature. +#2. We recommend using the cluster.web.tcp.port option. However, in cases where the collector is unable to establish connection to the web, you may reverse this and make the web establish connection to the collector. +# In this case, you must set cluster.connect.address (pinpoint-web.properties); and cluster.listen.ip, cluster.listen.port (pinpoint-collector.properties) accordingly. cluster.enable=true cluster.web.tcp.port=29997 cluster.zookeeper.address=localhost diff --git a/web/src/main/resources/pinpoint-web.properties b/web/src/main/resources/pinpoint-web.properties index 61153f362543..285eca7613d6 100644 --- a/web/src/main/resources/pinpoint-web.properties +++ b/web/src/main/resources/pinpoint-web.properties @@ -1,4 +1,16 @@ -#local +# ------------------------------------------------------------------------------------------------- +# The cluster related options are used to establish connections between the agent, collector, and web in order to send/receive data between them in real time. +# You may enable additional features using this option (Ex : RealTime Active Thread Chart). +# ------------------------------------------------------------------------------------------------- +# Usage : Set the following options for collector/web components that reside in the same cluster in order to enable this feature. +# 1. cluster.enable (pinpoint-web.properties, pinpoint-collector.properties) - "true" to enable +# 2. cluster.zookeeper.address (pinpoint-web.properties, pinpoint-collector.properties) - address of the ZooKeeper instance that will be used to manage the cluster +# 3. cluster.web.tcp.port (pinpoint-web.properties) - any available port number (used to establish connection between web and collector) +# ------------------------------------------------------------------------------------------------- +# Please be aware of the following: +#1. If the network between web, collector, and the agents are not stable, it is advisable not to use this feature. +#2. We recommend using the cluster.web.tcp.port option. However, in cases where the collector is unable to establish connection to the web, you may reverse this and make the web establish connection to the collector. +# In this case, you must set cluster.connect.address (pinpoint-web.properties); and cluster.listen.ip, cluster.listen.port (pinpoint-collector.properties) accordingly. cluster.enable=true cluster.web.tcp.port=9997 cluster.zookeeper.address=localhost