Bug 1482527

Summary:	[RFE] [ODL] Tool to monitor ODL cluster
Product:	Red Hat OpenStack	Reporter:	Itzik Brown <itbrown>
Component:	opendaylight	Assignee:	Tim Rozet <trozet>
Status:	CLOSED WONTFIX	QA Contact:	Toni Freger <tfreger>
Severity:	high	Docs Contact:
Priority:	high
Version:	12.0 (Pike)	CC:	aschultz, dfarrell, lruzicka, mkolesni, oblaut, sclewis, skitt, tjamrisk, trozet
Target Milestone:	Upstream M2	Keywords:	FutureFeature, UserExperience
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2019-03-06 16:16:37 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1580518
Bug Blocks:	1569858

Description Itzik Brown 2017-08-17 13:19:35 UTC

Description of problem:
Currently the only way to monitor the cluster status is to use a REST API call 

For example:
curl -u admin:admin http://10.0.0.2:8081/jolokia/read/org.opendaylight.controller:Category=Shards,name=member-1-shard-default-config,type=DistributedConfigDatastore | python -m json.tool 

The output is in the JSON format and includes information such as who's the leader etc.
(Replacing the IP and the member name for each node in the cluster)

We need a tool to ease the monitoring of the cluster (CLI or GUI based)


Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 2 Itzik Brown 2017-08-17 13:38:11 UTC

There is a tool used in u/s testing - https://github.com/opendaylight/integration-test/tree/master/tools/clustering/cluster-monitor

Comment 3 Daniel Farrell 2017-08-17 13:40:05 UTC

+1, I suggest using the Int/Test cluster-monitor tool.

https://git.opendaylight.org/gerrit/gitweb?p=integration/test.git;a=tree;f=tools/clustering/cluster-monitor

If after using it you find it needs enhancements we can address those upstream/in different bugs. I don't think this tool should be packaged. So is this done?

Comment 18 Stephen Kitt 2017-12-20 20:33:37 UTC

With the upstream patch queue ending in https://git.opendaylight.org/gerrit/66680 (most of which has been merged), the upstream monitor.py tool is now stable and usable. We still need to package it.

Comment 36 Tim Rozet 2018-04-19 20:42:38 UTC

Posted a patch to networking-odl that will be installed as an executable in default PATH on the overcloud nodes.  I took the liberty of rewriting most of it as it did not conform to pep8, and also had a bunch of issues with exception handling, as well as corrupting a user's terminal on exit.

I'm not sure if this will be backportable or not to queens.  If not we may need to re-target this BZ.

Comment 40 Tim Rozet 2018-05-23 16:22:57 UTC

PR submitted:
https://github.com/shague/odltools/pull/14

Comment 42 Franck Baudin 2019-03-06 16:16:37 UTC

As per depreciation notice [1], closing this bug. Please reopen if relevant for RHOSP13, as this is the only version shipping ODL.

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/release_notes/index#deprecated_functionality

Comment 43 Franck Baudin 2019-03-06 16:17:46 UTC

As per depreciation notice [1], closing this bug. Please reopen if relevant for RHOSP13, as this is the only version shipping ODL.

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/release_notes/index#deprecated_functionality