This is an automated email from the ASF dual-hosted git repository.
jiangtian pushed a commit to branch log_tool
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git
The following commit(s) were added to refs/heads/log_tool by this push:
new b90c4c4 add request of knowing regular expressions in documents add
comment to the example plan
b90c4c4 is described below
commit b90c4c41498f52f3363b08d7d1ef34760c009b01
Author: jt <[email protected]>
AuthorDate: Tue Sep 3 09:11:54 2019 +0800
add request of knowing regular expressions in documents
add comment to the example plan
---
docs/Documentation-CHN/UserGuide/8-System Tools/3-Log Visualizer.md | 4 ++++
docs/Documentation/UserGuide/8-System Tools/3-Log Visualizer.md | 5 +++++
.../resources/tools/logVisualize/plans/flushTimeConsumption.plan | 3 +++
3 files changed, 12 insertions(+)
diff --git a/docs/Documentation-CHN/UserGuide/8-System Tools/3-Log
Visualizer.md b/docs/Documentation-CHN/UserGuide/8-System Tools/3-Log
Visualizer.md
index d405aab..1e60062 100644
--- a/docs/Documentation-CHN/UserGuide/8-System Tools/3-Log Visualizer.md
+++ b/docs/Documentation-CHN/UserGuide/8-System Tools/3-Log Visualizer.md
@@ -69,6 +69,10 @@
之后您能在这个目录下找到LogVisualizer的启动脚本：
`server/target/iotdb-server-{project-version}-SNAPSHOT/tools/logVisualize`
+如果您想要掌握本工具的一些进阶使用方法，您需要对正则表达式（特别是Java风格的正则表达式）有一些基本的
+了解。您只有在熟悉正则表达式以后才能新建可视化计划或者对已有的计划进行修改。如果您对正则表达式一无所知，
+我们也提供了一些预设的可视化计划供您使用，但这些可视化计划仅限于分析IoTDB。
+
## 启动图形界面
您可以通过脚本`log-visualizer.sh` (在Windows下为`log-visualizer.bat`)来启动LogVisualizer.
这将会启动
一个如下图所示的图形界面:
diff --git a/docs/Documentation/UserGuide/8-System Tools/3-Log Visualizer.md
b/docs/Documentation/UserGuide/8-System Tools/3-Log Visualizer.md
index 5fcfbca..981f27c 100644
--- a/docs/Documentation/UserGuide/8-System Tools/3-Log Visualizer.md
+++ b/docs/Documentation/UserGuide/8-System Tools/3-Log Visualizer.md
@@ -74,6 +74,11 @@ server module as a tool, you can build the server together
with LogVisualizer us
Then you fan find the scripts to start LogVisualizer in:
`server/target/iotdb-server-{project-version}-SNAPSHOT/tools/logVisualize`
+To have access to the advanced usages of this tool, you must have some basic
knowledge about regular
+expressions, especially Java style ones. Knowing about regular expressions
enables to create your own
+visualization plans or modify the existing ones. However, if you are totally
new to regular expressions,
+you can still use the preset plans which are only applicable to IoTDB.
+
## Run the gui
You can run LogVisualizer using `log-visualizer.sh` (or `log-visualizer.bat`
in windows). This
will bring you a gui like:
diff --git
a/server/src/assembly/resources/tools/logVisualize/plans/flushTimeConsumption.plan
b/server/src/assembly/resources/tools/logVisualize/plans/flushTimeConsumption.plan
index 779c1d1..6943730 100644
---
a/server/src/assembly/resources/tools/logVisualize/plans/flushTimeConsumption.plan
+++
b/server/src/assembly/resources/tools/logVisualize/plans/flushTimeConsumption.plan
@@ -17,6 +17,9 @@
# under the License.
#
+# This is a detailed example of visualization plan.Please read it carefully
before you write your
+# own plans.
+
# the name of the this plan
name=flushTimeConsumption
# a regular expression that defines how are the targeted logs formatted and
what fields are interesting and should be grouped
