Skip to content

Commit adb6360

Browse files
authored
More information when setting Prometheus endpoint (neo4j#587) (neo4j#611) (neo4j#614)
Cherry-picked from neo4j#587
1 parent 224d976 commit adb6360

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

modules/ROOT/pages/monitoring/metrics/expose.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,17 @@ metrics.prometheus.enabled=true
8181
metrics.prometheus.endpoint=localhost:2004
8282
----
8383

84-
When Neo4j is fully started a Prometheus endpoint will be available at the configured address.
84+
When Neo4j is fully started, a Prometheus endpoint will be available at the configured address.
8585

86+
[WARNING]
87+
====
88+
You should never expose the Prometheus endpoint directly to the Internet.
89+
If security is of paramount importance, you should set `metrics.prometheus.endpoint=localhost:2004` and configure a reverse HTTP proxy on the same machine that handles the authentication, SSL, caching, etc.
90+
====
91+
If you can afford to send unencrypted metrics within the internal network, such as `metrics.prometheus.endpoint=10.0.0.123:2004`, all servers within the same netmask will be able to access it.
92+
93+
If you specify anything more permissible, such as `metrics.prometheus.endpoint=0.0.0.0:2004`, you should have a firewall rule to prevent any unauthorized access.
94+
Data in transit will still not be encrypted, so it should never go other any insecure networks.
8695

8796
[[metrics-csv]]
8897
== CSV files
@@ -119,4 +128,4 @@ In order to enable metrics exposure via JMX, add the following setting to xref:c
119128
metrics.jmx.enabled=true
120129
----
121130

122-
For more information about accessing and adjusting the metrics, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/jmx-metrics/[The Java Reference Guide -> JMX metrics].
131+
For more information about accessing and adjusting the metrics, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/jmx-metrics/[The Java Reference Guide -> JMX metrics].

modules/ROOT/partials/neo4j-config/all-settings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4465,7 +4465,7 @@ m|false
44654465
|Description
44664466
a|The hostname and port to use as Prometheus endpoint.
44674467
|Valid values
4468-
a|metrics.prometheus.endpoint, a socket address. If missing port or hostname it is acquired from dbms.default_listen_address
4468+
a|metrics.prometheus.endpoint, a socket address in the format `hostname:port`, `hostname`, or `:port`. If missing, port and hostname are acquired from `dbms.default_listen_address`.
44694469
|Default value
44704470
m|localhost:2004
44714471
|===

0 commit comments

Comments
 (0)