You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2019/09/26 04:52:21 UTC

[incubator-iotdb] branch master updated: Add JMX document (#422)

This is an automated email from the ASF dual-hosted git repository.

qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 6fe298d  Add JMX document (#422)
6fe298d is described below

commit 6fe298dc95e3297ecd84baad23146b69f6c8c55a
Author: Zesong Sun <sz...@mails.tsinghua.edu.cn>
AuthorDate: Thu Sep 26 12:52:16 2019 +0800

    Add JMX document (#422)
---
 .../UserGuide/9-System Tools/3-JMX Tool.md         | 34 +++++++++++++++
 docs/Documentation/UserGuide/0-Content.md          |  1 +
 .../{0-Content.md => 9-System Tools/3-JMX Tool.md} | 51 +++++-----------------
 3 files changed, 47 insertions(+), 39 deletions(-)

diff --git a/docs/Documentation-CHN/UserGuide/9-System Tools/3-JMX Tool.md b/docs/Documentation-CHN/UserGuide/9-System Tools/3-JMX Tool.md
new file mode 100644
index 0000000..4f8f982
--- /dev/null
+++ b/docs/Documentation-CHN/UserGuide/9-System Tools/3-JMX Tool.md	
@@ -0,0 +1,34 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+# 第9章: 系统工具
+
+# JMX工具
+
+Java VisualVM提供了一个可视化的界面,用于查看Java应用程序在Java虚拟机(JVM)上运行的详细信息,并对这些应用程序进行故障排除和分析。
+
+## 使用
+
+第一步:启动IoTDB server。
+
+第二步:建立连接。对于本地的监控,不需要手动配置连接。对于远程的监控,可以添加远程的ip地址,并将端口配置为`31999`。
+
+第三步:开始监控。双击你所建立的ip地址,就可以看到执行应用的详细信息。
diff --git a/docs/Documentation/UserGuide/0-Content.md b/docs/Documentation/UserGuide/0-Content.md
index 07aa1cf..6c0299f 100644
--- a/docs/Documentation/UserGuide/0-Content.md
+++ b/docs/Documentation/UserGuide/0-Content.md
@@ -59,3 +59,4 @@
 # Chapter 9: System Tools
 * 1-Sync
 * 2-Memory Estimation Tool
+* 3-JMX Tool
diff --git a/docs/Documentation/UserGuide/0-Content.md b/docs/Documentation/UserGuide/9-System Tools/3-JMX Tool.md
similarity index 51%
copy from docs/Documentation/UserGuide/0-Content.md
copy to docs/Documentation/UserGuide/9-System Tools/3-JMX Tool.md
index 07aa1cf..7913391 100644
--- a/docs/Documentation/UserGuide/0-Content.md
+++ b/docs/Documentation/UserGuide/9-System Tools/3-JMX Tool.md	
@@ -19,43 +19,16 @@
 
 -->
 
-# Chapter 1: Overview
-* 1-What is IoTDB
-* 2-Architecture
-* 3-Scenario
-* 4-Features
-# Chapter 2: Concept Key Concepts and Terminology
-* 1-Key Concepts and Terminology
-* 2-Data Type 
-* 3-Encoding 
-* 4-Compression 
-# Chapter 3: Operation Manual
-* 1-Sample Data
-* 2-Data Model Selection
-* 3-Data Import
-* 4-Data Query
-* 5-Data Maintenance
-* 6-Priviledge Management
-# Chapter 4: Deployment and Management
-* 1-Deployment
-* 2-Configuration
-* 3-System Monitor
-* 4-Performance Monitor
-* 5-System log
-* 6-Data Management
-* 7-Build and use IoTDB by Dockerfile
-# Chapter 5: IoTDB SQL Documentation
-* 1-IoTDB Query Statement
-* 2-Reference
-# Chapter 6: JDBC API
-* 1-JDBC API
-* 2-Status Code
-# Chapter 7: Session API
-* 1-Session API
-# Chapter 8: TsFile
-* 1-Installation
-* 2-Usage
-* 3-Hierarchy
 # Chapter 9: System Tools
-* 1-Sync
-* 2-Memory Estimation Tool
+
+# JMX Tool
+
+Java VisualVM is a tool that provides a visual interface for viewing detailed information about Java applications while they are running on a Java Virtual Machine (JVM), and for troubleshooting and profiling these applications. 
+
+## Usage
+
+Step1: Start sever.
+
+Step2: Build connection. For local monitor, connection doesn't need to be built manually. For remote monitor, you can add your own ip address, and config the port. For IoTDB, port is `31999`.
+
+Step3: Start monitoring. By double clicking your connection ip address, you can see the detailed execution information about the application.