You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/jmx-metrics.adoc
+23-24Lines changed: 23 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,45 +6,44 @@
6
6
7
7
This topic describes how to access JMX for Neo4j DBMS to monitor metrics.
8
8
9
-
Neo4j provides different levels of monitoring facilities in order to supply a continuous overview of the system's health.
9
+
Neo4j provides different levels of monitoring facilities to supply a continuous overview of the system's health.
10
10
For a description of the monitoring options, see link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring[Neo4j Operations Manual -> Monitoring].
11
11
Many of the metrics are exposed through link:https://www.oracle.com/java/technologies/javase/javamanagement.html[JMX^].
12
12
13
13
[NOTE]
14
14
====
15
-
Please note that the available JMX MBeans and their names have been updated in Neo4j 4.0.
16
-
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring[Neo4j Operations Manual -> Monitoring], have been removed.
15
+
The available JMX MBeans and their names have been updated in Neo4j 4.0.
16
+
Beans that duplicate metrics or monitoring options, described in link:{neo4j-docs-base-uri}/operations-manual/{page-version}/monitoring/metrics/reference/#jvm-metrics[Neo4j Operations Manual -> Monitoring], have been removed.
17
17
====
18
18
19
-
20
19
[[jmx-remote]]
21
20
== Adjusting remote JMX access to Neo4j
22
21
23
-
Per default, the Neo4j Enterprise Server edition does not allow remote JMX connections.
22
+
By default, the Neo4j Enterprise edition does not allow remote JMX connections.
24
23
To enable this feature, you need to enable JMX Remote Management and also configure JMX for secure remote access, in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_conf/neo4j.conf_ file].
25
24
26
25
27
26
[[enable-jmx-remote]]
28
27
=== Enable JMX Remote Management
29
28
30
29
Add the following lines to the _conf/neo4j.conf_ file to enable JMX Remote Management.
31
-
If you run into issues with automatic host name discovery, you can uncomment the following configuration line:
30
+
If you run into issues with automatic hostname discovery, you can uncomment the following configuration line:
Although SSL for JMX Remote Management is disabled throughout this document, to configure it based on your requirements you can follow the instructions in the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^].
46
+
Although SSL for JMX Remote Management is disabled throughout this document, to configure it based on your requirements, you can follow the instructions in the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^].
48
47
====
49
48
50
49
@@ -54,7 +53,7 @@ Although SSL for JMX Remote Management is disabled throughout this document, to
54
53
Password authentication is enabled by default in JMX Remote Management.
55
54
You can find information about setting up authentication with LDAP and file-based approach in the following sections.
56
55
57
-
Please refer to the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^] for more options, including configuration steps for SSL client authentication.
56
+
Refer to the link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html[Java SE 11 Monitoring and Management Guide^] for more options, including configuration steps for SSL client authentication.
58
57
59
58
60
59
[[ldap]]
@@ -104,8 +103,8 @@ After finishing your JAAS configuration, configure JMX to use it by adding the f
With this setup, you can connect to JMX monitoring of the Neo4j server using `<IP-OF-SERVER>:3637`, with a valid username and password defined in your LDAP directory.
@@ -116,18 +115,18 @@ With this setup, you can connect to JMX monitoring of the Neo4j server using `<I
116
115
117
116
[IMPORTANT]
118
117
====
119
-
The file-based password authentication stores the password in clear-text and is intended only for development use.
118
+
The file-based password authentication stores the password in cleartext and is intended only for development use.
120
119
====
121
120
122
121
You can set your password for JMX remote access and save it in the _conf/jmx.password_ configuration file.
123
-
Please note that on Unix-based systems, the _jmx.password_ file needs to be owned by the user that will run the server, and have permissions set to `0600`.
122
+
Note that on Unix-based systems, the _jmx.password_ file needs to be owned by the user that runs the server, and has permissions set to `0600`.
124
123
125
124
[source, properties]
126
125
----
127
126
monitorRole password_to_be_changed
128
127
----
129
128
130
-
Next, configure access level and save it in _conf/jmx.access_ configuration file.
129
+
Next, configure the access level and save it in _conf/jmx.access_ configuration file.
131
130
132
131
[source, properties]
133
132
----
@@ -138,8 +137,8 @@ Finally, configure JMX to use the completed password and access files by adding
With this setup, you can connect to JMX monitoring of the Neo4j server using `<IP-OF-SERVER>:3637`, with the username `monitor`, and the password `password_to_be_changed`.
@@ -167,11 +166,11 @@ Connect to the process running your Neo4j database instance:
167
166
.Connecting JConsole to the Neo4j Java process
168
167
image::jconsole_connect1.png[alt="Connecting with JConsole", width=300]
169
168
170
-
Now, beside the MBeans exposed by the JVM, you will see be default `neo4j.metrics` section in the MBeans tab.
171
-
Under that, you will have access to all the monitoring information exposed by Neo4j.
169
+
Besides the MBeans, exposed by the JVM, you also see be default `neo4j.metrics` section in the MBeans tab.
170
+
Under that, you have access to all the monitoring information exposed by Neo4j.
172
171
173
172
For opening JMX to remote monitoring access, please see <<jmx-remote>> and link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html#GUID-805517EC-2D33-4D61-81D8-4D0FA770D1B8[the JMX documention^].
0 commit comments