Skip to content

Commit f17a0b5

Browse files
renetapopovarenetapopova
authored
Add Discover local servers (#3059)
1 parent 92458a0 commit f17a0b5

5 files changed

Lines changed: 113 additions & 4 deletions

File tree

‎modules/ROOT/content-nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@
280280
** xref:monitoring/background-jobs.adoc[]
281281
** xref:monitoring/neo4j-admin-report.adoc[]
282282
** xref:monitoring/fleet-management.adoc[]
283+
** xref:monitoring/fleet-discovery.adoc[]
283284
// ** xref:monitoring/cluster/index.adoc[]
284285
// *** xref:monitoring/cluster/procedures.adoc[]
285286
// *** xref:monitoring/cluster/http-endpoints.adoc[]

‎modules/ROOT/pages/monitoring/fleet-discovery.adoc‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
:description: Discover your local Neo4j servers and add them to Fleet Manager in the Aura console to monitor them alongside your Aura deployments.
2+
:keywords: fleet management, monitoring, neo4j, aura, self-managed, discover local servers, fleet discovery, neo4j-admin fleet discover
3+
:page-role: new-2026.05
4+
[[discover-local-servers]]
5+
= Discover local servers
6+
7+
You can use the `neo4j-admin fleet discover` command to automatically discover all Neo4j servers running on your local network and provide you with a registration code that you can use to add those servers to Fleet Manager in the Aura console.
8+
9+
10+
== Syntax
11+
12+
The `neo4j-admin fleet discover` command has the following syntax:
13+
14+
[source,bash]
15+
----
16+
neo4j-admin fleet discover [-h] [--expand-commands] [--verbose]
17+
[--filename=<filename>] [--format=<format>]
18+
[--timeout=<timeout>]
19+
----
20+
21+
== Description
22+
23+
The command listens for Neo4j fleet discovery broadcasts on the local network and lists all discovered Neo4j servers.
24+
25+
== Options
26+
27+
The `neo4j-admin fleet discover` command has the following options:
28+
29+
.`neo4j-admin fleet discover` options
30+
[options="header", cols="5m,6a,2m"]
31+
|===
32+
| Option
33+
| Description
34+
| Default
35+
36+
|--expand-commands
37+
|Allow command expansion in config value evaluation.
38+
|
39+
40+
|--filename=<filename>
41+
| Optional filename to which discovered servers will be written.
42+
|
43+
44+
|--format=<format>
45+
| Output format (pretty, csv, json).
46+
| Pretty
47+
48+
|-h, --help
49+
|Show this help message and exit.
50+
|
51+
52+
|--timeout=<timeout>
53+
| Timeout in seconds.
54+
| 60
55+
56+
|--verbose
57+
|Enable verbose output.
58+
|
59+
|===
60+
61+
== Example
62+
63+
The following example shows how to use the `neo4j-admin fleet discover` command to discover Neo4j servers on the local network:
64+
65+
[source,bash]
66+
----
67+
bin/neo4j-admin fleet discover
68+
----
69+
70+
.Example output
71+
[result]
72+
----
73+
Listening for Neo4j discovery broadcasts on port 8687 for a duration of 60 seconds
74+
75+
Discovered 1 Neo4j server
76+
77+
DBMS ID: 192A83F39D18F8DA0E2CDE0EF1D1B8E7E87CF50CC82D309C88734AEC872864CF
78+
Address: localhost:7687
79+
80+
Server ID: 72663169-aab7-4cfc-a58e-c207d29c810d
81+
Version: 2026.06.0-57838
82+
Edition: enterprise
83+
Address: localhost:7687
84+
85+
To add discovered servers with Fleet Manager, log in or sign up to Neo4j Aura and open the dialog to add deployments from Neo4j Admin.
86+
Please see the documentation at: https://neo4j.com/docs/aura/fleet-management/setup/
87+
When prompted, paste the following code into the dialog:
88+
89+
W3siZGJtc0lkIjoiMTkyQTgzRjM5RDE4RjhEQTBFMkNERTBFRjFEMUI4RTdFODdDRjUwQ0M4MkQzMDlDODg3MzRBRUM4NzI4NjRDRiIsInNlcnZlckNvdW50IjoxLCJhZGRyZXNzZXMiOlsibG9jYWxob3N0Ojc2ODciXX1d
90+
----
91+
92+
After pasting the code in the Aura console, you can decide which of the discovered servers you want to monitor and add them to your fleet.
93+
For more information, see link:{neo4j-docs-base-uri}/aura/fleet-management/setup/#discover-deployments[Aura documentation -> Discover deployments].
94+
95+
== Configure the fleet discovery service
96+
97+
The fleet discovery service is enabled by default, so that you can easily discover and monitor your local Neo4j servers in Fleet Manager.
98+
However, if you need to disable it, you can do so by setting the xref:configuration/configuration-settings.adoc#config_server.fleet_discovery.enabled[`server.fleet_discovery.enabled`] configuration parameter to `false` in your _neo4j.conf_ file.
99+
100+
Additionally, you can specify a custom port for the fleet discovery service to listen on by setting xref:configuration/configuration-settings.adoc#config_server.fleet_discovery.port[`server.fleet_discovery.port`] or change the delay between broadcasts by setting xref:configuration/configuration-settings.adoc#config_server.fleet_discovery.broadcast_interval[`server.fleet_discovery.broadcast_interval`].
101+
The base value for the broadcast interval is 30 seconds, but it can be adjusted by adding a jitter interval to prevent all servers from broadcasting at the same time.
102+
You can set the jitter interval using the xref:configuration/configuration-settings.adoc#config_server.fleet_discovery.broadcast_interval_jitter[`server.fleet_discovery.jitter_interval`] configuration setting.

‎modules/ROOT/pages/monitoring/fleet-management.adoc‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
= Monitor your deployments using Fleet Manager
1+
:description: Monitor your Neo4j deployments using Fleet Manager, a tool that allows you to monitor all of your Neo4j instances, both Aura and self-managed, directly from the Aura console.
2+
:keywords: fleet management, monitoring, neo4j, aura, self-managed, metrics, topology information, server configuration, database metadata, license status
3+
:page-role: new-2025.08
4+
= Monitor your self-managed deployments in Aura
25

36
Fleet Manager allows you to monitor *all* of your Neo4j instances, both Aura and self-managed, directly from the Aura console.
47
It collects the following information from your deployment and securely transmits it to Aura:
@@ -15,5 +18,6 @@ In earlier versions, it is available as a plugin that you can install in your se
1518
These includes versions Neo4j 4.4.45+, 5.26.12+, and versions between 2025.08.0 and 2026.02.2 inclusive.
1619
For details on how to enable the Fleet management plugin in those versions, see xref:configuration/plugins.adoc#install-and-configure-plugins[Install and configure plugins].
1720

18-
To access Fleet Manager, go to *Instances* under the *Self-managed* tab in the Aura console.
19-
For more information on how to use Fleet Manager, see link:{neo4j-docs-base-uri}/aura/fleet-management/overview/[Fleet Manager].
21+
To access and use Fleet Manager, go to *Instances* under the *Self-managed* tab in the Aura console.
22+
See link:{neo4j-docs-base-uri}/aura/fleet-management/overview/[Fleet Manager] in the Aura documentation for more information.
23+
To learn how to discover your local Neo4j servers and add them to Fleet Manager, see xref:monitoring/fleet-discovery.adoc[Discover local servers].

‎modules/ROOT/pages/monitoring/index.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ This chapter describes the following:
2929
** xref:monitoring/background-jobs.adoc#background-jobs-active[Listing active background jobs]
3030
** xref:monitoring/background-jobs.adoc#background-jobs-failed[Listing failed job executions]
3131
* xref:monitoring/neo4j-admin-report.adoc[Generate a report about the system]
32-
32+
* xref:monitoring/fleet-management.adoc[Monitor your self-managed deployments in Aura]
33+
* xref:monitoring/fleet-discovery.adoc[Discover local servers]

‎modules/ROOT/pages/neo4j-admin-neo4j-cli.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ For details, see xref:backup-restore/validate.adoc[].
208208
| `discover`
209209
| label:new[Introduced in 2026.05] +
210210
Listen for Neo4j fleet discovery broadcasts on the local network and list all discovered Neo4j servers.
211+
For more information, see xref:monitoring/fleet-discovery.adoc[Discover local servers].
211212
|===
212213

213214
== The `neo4j` tool

0 commit comments

Comments
 (0)