HzSessions HOWTO - Revision history

Dominik.epple at 07:02, 26 October 2017

2017-10-26T07:02:56Z

← Older revision		Revision as of 07:02, 26 October 2017
Line 1:		Line 1:
	= HOWTO - Access session list in Hazelcast storage =		= HOWTO - Access session list in Hazelcast storage =

			'''Note: currenty this script is disfunctional as our current jolokia security setup disables the correponding request. Keeping that page for historical reasons.'''

	This article describes how to access session information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge.		This article describes how to access session information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge.

WolfgangRosenauer: /* HOWTO - Access session list in Hazelcast storage */

2015-12-30T10:10:36Z

HOWTO - Access session list in Hazelcast storage

← Older revision		Revision as of 10:10, 30 December 2015
Line 8:		Line 8:

	* Prepare your system to be able to use Jolokia: [[Jolokia]]		* Prepare your system to be able to use Jolokia: [[Jolokia]]
	* Another example using the concept: [[Jolokia_LoginCounter_HOWTO]]
	* Get this archive [[File:Listsessions.zip]] and install it on any node		* Get this archive [[File:Listsessions.zip]] and install it on any node
	* Replace username, password and baseurl in listsessions.pl to match your Jolokia configuration		* Replace username, password and baseurl in listsessions.pl to match your Jolokia configuration
Line 24:		Line 23:
	* USM sessions do not appear in the output		* USM sessions do not appear in the output


			Generic HOWTO about the concept for using Jolokia to get JMX provided data: [[Jolokia_LoginCounter_HOWTO]]

WolfgangRosenauer: /* HOWTO - Access session list in Hazelcast storage */

2015-12-30T10:07:40Z

HOWTO - Access session list in Hazelcast storage

← Older revision		Revision as of 10:07, 30 December 2015
Line 5:		Line 5:
	Currently there is no dedicated tool shipped with Open-Xchange to get information about currently existing sessions on the system. This documentation and provided example script exposes access to this information if [[AppSuite:Running_a_cluster#Distributed_Session_Storage\|open-xchange-sessionstorage-hazelcast]] is used to provide clusterwide session management.		Currently there is no dedicated tool shipped with Open-Xchange to get information about currently existing sessions on the system. This documentation and provided example script exposes access to this information if [[AppSuite:Running_a_cluster#Distributed_Session_Storage\|open-xchange-sessionstorage-hazelcast]] is used to provide clusterwide session management.

	Please note that the script referenced here is by no means production ready or supported! Use and modify it on your own risk!		'''Please note that the script referenced here is by no means production ready or supported! Use and modify it on your own risk!'''

	* Prepare your system to be able to use Jolokia: [[Jolokia]]		* Prepare your system to be able to use Jolokia: [[Jolokia]]

WolfgangRosenauer at 10:05, 30 December 2015

2015-12-30T10:05:59Z

← Older revision		Revision as of 10:05, 30 December 2015
Line 4:		Line 4:

	Currently there is no dedicated tool shipped with Open-Xchange to get information about currently existing sessions on the system. This documentation and provided example script exposes access to this information if [[AppSuite:Running_a_cluster#Distributed_Session_Storage\|open-xchange-sessionstorage-hazelcast]] is used to provide clusterwide session management.		Currently there is no dedicated tool shipped with Open-Xchange to get information about currently existing sessions on the system. This documentation and provided example script exposes access to this information if [[AppSuite:Running_a_cluster#Distributed_Session_Storage\|open-xchange-sessionstorage-hazelcast]] is used to provide clusterwide session management.

			Please note that the script referenced here is by no means production ready or supported! Use and modify it on your own risk!

	* Prepare your system to be able to use Jolokia: [[Jolokia]]		* Prepare your system to be able to use Jolokia: [[Jolokia]]
Line 9:		Line 11:
	* Get this archive [[File:Listsessions.zip]] and install it on any node		* Get this archive [[File:Listsessions.zip]] and install it on any node
	* Replace username, password and baseurl in listsessions.pl to match your Jolokia configuration		* Replace username, password and baseurl in listsessions.pl to match your Jolokia configuration
	* ... ~~WIP~~ ...
			Example output

			[root@ox1 ox]# ./listsessions.pl
			contextId:47 userId:2 login:userA client:open-xchange-appsuite localIp:A.B.C.D
			contextId:10004 userId:2 login:userB client:OSX.OXDrive localIp:A.B.C.D


			Limitations

			* DAV sessions are not saved into Hazelcast because they are transient and short living, therefore not appearing in the output
			* USM sessions do not appear in the output

WolfgangRosenauer at 19:08, 29 December 2015

2015-12-29T19:08:30Z

@@ Line 1: / Line 1: @@
-= HOWTO - Access session list in hazelcast Jolokia =
+= HOWTO - Access session list in Hazelcast storage =
-This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, to get information about the current sessions.
+This article describes how to access session information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge.
-== Enable Jolokia ==
+Currently there is no dedicated tool shipped with Open-Xchange to get information about currently existing sessions on the system. This documentation and provided example script exposes access to this information if [[AppSuite:Running_a_cluster#Distributed_Session_Storage|open-xchange-sessionstorage-hazelcast]] is used to provide clusterwide session management.
-(See also https://oxpedia.org/wiki/index.php?title=Jolokia)
+* Prepare your system to be able to use Jolokia: [[Jolokia]]

Dominik.epple at 18:20, 29 December 2015

2015-12-29T18:20:58Z

← Older revision		Revision as of 18:20, 29 December 2015
Line 38:		Line 38:

	Reload your apache config and restart open-xchange for the changes to take effect.		Reload your apache config and restart open-xchange for the changes to take effect.

			[[File:Listsessions.zip]]

WolfgangRosenauer: Created page with "= HOWTO - Access session list in hazelcast Jolokia = This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge..."

2015-12-29T17:55:02Z

Created page with "= HOWTO - Access session list in hazelcast Jolokia = This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge..."

New page

= HOWTO - Access session list in hazelcast Jolokia =

This article describes how to access information exposed through JMX by Open-Xchange with the Jolokia JMX-to-HTTP bridge, to get information about the current sessions.

== Enable Jolokia ==

(See also https://oxpedia.org/wiki/index.php?title=Jolokia)

In <code>etc/jolokia.properties</code>, enable Jolokia by setting the following properties:

com.openexchange.jolokia.start = true
com.openexchange.jolokia.user = youruser
com.openexchange.jolokia.password = yourpassword

Jolokia will not be enabled when no user/password is set.

You can optionally adjust this setting:

com.openexchange.jolokia.servlet.name = /monitoring/jolokia

If you do, you need to adjust the examples below as well.

== Allow access from other hosts ==

This is an optional step, if you want to access the Jolokia interface from other hosts than localhost. This may be very helpful during the development phase of a project. Please be aware that this interface exposes lots of "interesting" data, so if you remove the restriction to localhost, you need to ensure by other means (network setup, firewalls, web server configuration, ...) that no unauthorised access is possible on production systems.

In <code>etc/jolokia.properties</code>, set:

com.openexchange.jolokia.restrict.to.localhost = false

In your web server configuration, enable access to the jolokia servlet. For Apache this is possible by adding a ProxyPass directive for each OX host in the cluster:

ProxyPass /monitoring/ox1/jolokia http://ox1-ip:8009/monitoring/jolokia
ProxyPass /monitoring/ox2/jolokia http://ox2-ip:8009/monitoring/jolokia
...

On a default installation as described by our installation guides, this would be in <code>proxy_http.conf</code>.

Reload your apache config and restart open-xchange for the changes to take effect.

[[Category:AppSuite]]
[[Category:Server]]
[[Category:Administrator]]