Github user mmiklavc commented on a diff in the pull request:
https://github.com/apache/metron/pull/988#discussion_r182152983
--- Diff: metron-platform/metron-common/README.md ---
@@ -400,3 +401,34 @@ __Side Effects__
Calling the mark() method multiple times simply resets the start time to
the current nano time. Calling log() with a non-existent mark name will log 0
ns elapsed time with a warning indicating that log has been invoked for a mark
name that does not exist.
The class is not thread-safe and makes no attempt at keeping multiple
threads from modifying the same markers.
+# Metron Debugging
+
+A Python script is provided for gathering information useful in debugging
your Metron cluster. Run from the node that has Metron installed on it. All
options listed below are required.
+
+_Note:_ Be aware that no anonymization/scrubbing is performed on the
captured configuration details.
+
+```
+# ./cluster_info.py -h
--- End diff --
@nickwallen fixed to reference $METRON_HOME/bin
---
