From dd4592a825ae713f40c162bb77a3eb37e290e3a5 Mon Sep 17 00:00:00 2001 From: Alexander Bouriakov Date: Thu, 22 May 2025 17:26:13 +0200 Subject: [PATCH 1/5] WIP fleet management documentation --- modules/ROOT/content-nav.adoc | 3 + .../ROOT/pages/fleet-management/overview.adoc | 307 ++++++++++++++++++ 2 files changed, 310 insertions(+) create mode 100644 modules/ROOT/pages/fleet-management/overview.adoc diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 81034b076..013572425 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -113,6 +113,9 @@ Generic Start * xref:billing.adoc[Billing] +* Fleet management +* xref:fleet-management/overview.adoc[Overview] + * Connecting applications ** xref:connecting-applications/overview.adoc[Drivers and libraries] ** xref:connecting-applications/query-api.adoc[Using Query API] diff --git a/modules/ROOT/pages/fleet-management/overview.adoc b/modules/ROOT/pages/fleet-management/overview.adoc new file mode 100644 index 000000000..4a6f8a534 --- /dev/null +++ b/modules/ROOT/pages/fleet-management/overview.adoc @@ -0,0 +1,307 @@ += Fleet Management Plugin Documentation + +This document describes the data structures used in fleet management messages. + +== ConnectMessage + +Message sent from the server to the Fleet Management service to establish a connection + +[cols="1,1,1,1"] +|=== +|Field |Type |Description |Values +|serverId +|String +|Unique identifier for the server +| +|name +|String +|Name of the server +| +|dbmsId +|String +|Unique identifier for the DBMS instance +| +|serverVersion +|String +|Version of the server +| +|projectId +|String +|Identifier for the project +| +|buildProfile +|String +|Build profile of the server +| +|=== + +== MetricsMessage + +Message sent from the server to the Fleet Management service containing metrics data + +[cols="1,1,1,1"] +|=== +|Field |Type |Description |Values +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +| +|projectId +|String +|Identifier for the project +| +|dbmsId +|String +|Unique identifier for the DBMS instance +| +|serverId +|String +|Unique identifier for the server +| +|metrics +|Map> +|Map of metric names to lists of DataPoint objects +|Values not yet known. +|metrics<>[].tags +|Map +|Map of string key-value pairs providing additional context for the metric +| +|metrics<>[].value +|Double +|Double value representing the metric measurement +| +|=== + +== ReportingMessage + +Message sent from the server to the Fleet Management service containing reporting data + +[cols="1,1,1,1"] +|=== +|Field |Type |Description |Values +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +| +|projectId +|String +|Identifier for the project +| +|dbms +|Dbms +|DBMS information object +| +|dbms.dbmsId +|String +|Unique identifier for the DBMS instance +| +|dbms.serverId +|String +|Unique identifier for the server +| +|dbms.databases +|List +|List of database names +| +|dbms.edition +|String +|Edition of the DBMS (e.g., Enterprise, Community) +| +|dbms.packaging +|String +|Packaging information of the DBMS +| +|dbms.servers +|List +|List of servers in the DBMS cluster +| +|dbms.servers[].serverId +|String +|Unique identifier for the server +| +|dbms.servers[].address +|String +|Network address of the server +| +|dbms.servers[].health +|String +|Current health status of the server +| +|dbms.servers[].modeConstraint +|String +|Mode constraint of the server +| +|dbms.servers[].version +|String +|Version of the server software +| +|dbms.servers[].databases +|List +|List of databases hosted on this server +| +|dbms.servers[].databases[].name +|String +|Name of the database +| +|dbms.servers[].databases[].role +|String +|Role of the database in the cluster +| +|dbms.servers[].databases[].aliases +|List +|List of database aliases +| +|dbms.servers[].databases[].access +|String +|Access level of the database +| +|dbms.servers[].databases[].databaseId +|String +|Unique identifier for the database +| +|dbms.servers[].databases[].requestedStatus +|String +|Requested status of the database +| +|dbms.servers[].databases[].currentStatus +|String +|Current status of the database +| +|dbms.servers[].databases[].statusMessage +|String +|Status message describing the current state +| +|dbms.servers[].databases[]._default +|boolean +|Whether this is the default database +| +|dbms.servers[].databases[].home +|boolean +|Whether this is the home database +| +|dbms.servers[].databases[].currentPrimariesCount +|long +|Current number of primary instances +| +|dbms.servers[].databases[].currentSecondariesCount +|long +|Current number of secondary instances +| +|dbms.servers[].databases[].requestedPrimariesCount +|Integer +|Requested number of primary instances +| +|dbms.servers[].databases[].requestedSecondariesCount +|Integer +|Requested number of secondary instances +| +|dbms.servers[].databases[].creationTime +|long +|Timestamp when the database was created +| +|dbms.servers[].databases[].lastStartTime +|long +|Timestamp when the database was last started +| +|dbms.servers[].databases[].store +|String +|Store information for the database +| +|dbms.servers[].databases[].writer +|boolean +|Whether this instance is a writer +| +|dbms.servers[].databases[].lastCommittedTxn +|Integer +|Last committed transaction ID +| +|dbms.servers[].databases[].replicationLag +|Integer +|Current replication lag +| +|dbms.servers[].license +|License +|Main license information +| +|dbms.servers[].license.type +|String +|Type of the license +| +|dbms.servers[].license.state +|String +|Current state of the license +| +|dbms.servers[].license.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +| +|dbms.servers[].license.totalTrialDays +|Integer +|Total number of days in trial period +| +|dbms.servers[].bloomLicense +|License +|Bloom license information +| +|dbms.servers[].bloomLicense.type +|String +|Type of the license +| +|dbms.servers[].bloomLicense.state +|String +|Current state of the license +| +|dbms.servers[].bloomLicense.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +| +|dbms.servers[].bloomLicense.totalTrialDays +|Integer +|Total number of days in trial period +| +|dbms.servers[].gdsLicense +|License +|GDS license information +| +|dbms.servers[].gdsLicense.type +|String +|Type of the license +| +|dbms.servers[].gdsLicense.state +|String +|Current state of the license +| +|dbms.servers[].gdsLicense.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +| +|dbms.servers[].gdsLicense.totalTrialDays +|Integer +|Total number of days in trial period +| +|pluginVersion +|String +|Version of the fleet management plugin +| +|osName +|String +|Operating system name +| +|osVersion +|String +|Operating system version +| +|osArch +|String +|Operating system architecture +| +|jvmVersion +|String +|Java Virtual Machine version +| +|jvmVendor +|String +|Java Virtual Machine vendor +| +|=== + From dde4288ea236939900695f9fe2c717160e1ebc92 Mon Sep 17 00:00:00 2001 From: Alexander Bouriakov Date: Fri, 30 May 2025 13:00:56 +0200 Subject: [PATCH 2/5] WIP fleet management documentation --- modules/ROOT/content-nav.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 013572425..6a9eb800a 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -114,7 +114,7 @@ Generic Start * xref:billing.adoc[Billing] * Fleet management -* xref:fleet-management/overview.adoc[Overview] +** xref:fleet-management/overview.adoc[Overview] * Connecting applications ** xref:connecting-applications/overview.adoc[Drivers and libraries] From a6e3407a815e9d691bbf99dd3a5d18ab7e412afa Mon Sep 17 00:00:00 2001 From: Alexander Bouriakov Date: Mon, 21 Jul 2025 17:16:22 +0200 Subject: [PATCH 3/5] update --- .../ROOT/pages/fleet-management/overview.adoc | 207 ++++++++++-------- 1 file changed, 111 insertions(+), 96 deletions(-) diff --git a/modules/ROOT/pages/fleet-management/overview.adoc b/modules/ROOT/pages/fleet-management/overview.adoc index 4a6f8a534..72ea24a5a 100644 --- a/modules/ROOT/pages/fleet-management/overview.adoc +++ b/modules/ROOT/pages/fleet-management/overview.adoc @@ -6,302 +6,317 @@ This document describes the data structures used in fleet management messages. Message sent from the server to the Fleet Management service to establish a connection -[cols="1,1,1,1"] +[cols="1,1,1"] |=== -|Field |Type |Description |Values -|serverId +|Field |Type |Description +|server_id |String |Unique identifier for the server -| |name |String |Name of the server -| -|dbmsId +|dbms_id |String |Unique identifier for the DBMS instance -| -|serverVersion +|server_version |String |Version of the server -| -|projectId +|project_id |String |Identifier for the project -| -|buildProfile +|plugin_version +|String +|Version of the plugin +|build_profile |String -|Build profile of the server -| +|Build profile of the plugin |=== == MetricsMessage Message sent from the server to the Fleet Management service containing metrics data -[cols="1,1,1,1"] +[cols="1,1,1"] |=== -|Field |Type |Description |Values +|Field |Type |Description |timestamp |long |Unix timestamp in milliseconds when the message was created -| -|projectId +|project_id |String |Identifier for the project -| -|dbmsId +|dbms_id |String |Unique identifier for the DBMS instance -| -|serverId +|server_id |String |Unique identifier for the server -| |metrics |Map> -|Map of metric names to lists of DataPoint objects -|Values not yet known. +|Map of metric names to lists of DataPoint objects. Values are dynamically populated from the Fleet Management server. |metrics<>[].tags |Map |Map of string key-value pairs providing additional context for the metric -| |metrics<>[].value |Double |Double value representing the metric measurement -| +|=== + +== Neo4jConfigMessage + +Message sent from the server to the Fleet Management service containing neo4j config data + +[cols="1,1,1"] +|=== +|Field |Type |Description +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +|project_id +|String +|Identifier for the project +|dbms_id +|String +|Unique identifier for the DBMS instance +|server_id +|String +|Unique identifier for the server +|neo4j_config +|Map +|Map of neo4j config names to config values. Values are dynamically populated from the Fleet Management server. +|=== + +== PingMessage + +Message sent from the server to the Fleet Management service to retrieve configuration updates + +[cols="1,1,1"] +|=== +|Field |Type |Description +|server_id +|String +|Unique identifier for the server +|server_version +|String +|Version of the server +|project_id +|String +|Identifier for the project |=== == ReportingMessage Message sent from the server to the Fleet Management service containing reporting data -[cols="1,1,1,1"] +[cols="1,1,1"] |=== -|Field |Type |Description |Values +|Field |Type |Description |timestamp |long |Unix timestamp in milliseconds when the message was created -| |projectId |String |Identifier for the project -| |dbms |Dbms |DBMS information object -| |dbms.dbmsId |String |Unique identifier for the DBMS instance -| |dbms.serverId |String |Unique identifier for the server -| |dbms.databases |List |List of database names -| |dbms.edition |String |Edition of the DBMS (e.g., Enterprise, Community) -| |dbms.packaging |String -|Packaging information of the DBMS -| +|Packaging of DBMS installation |dbms.servers |List |List of servers in the DBMS cluster -| |dbms.servers[].serverId |String |Unique identifier for the server -| +|dbms.servers[].name +|String +|Name of the server |dbms.servers[].address |String |Network address of the server -| |dbms.servers[].health |String |Current health status of the server -| +|dbms.servers[].state +|String +|Current state of the server |dbms.servers[].modeConstraint |String |Mode constraint of the server -| |dbms.servers[].version |String -|Version of the server software -| +|Neo4j version of the server |dbms.servers[].databases |List |List of databases hosted on this server -| |dbms.servers[].databases[].name |String |Name of the database -| |dbms.servers[].databases[].role |String |Role of the database in the cluster -| +|dbms.servers[].databases[].type +|String +|Type of the database in the cluster |dbms.servers[].databases[].aliases |List |List of database aliases -| |dbms.servers[].databases[].access |String |Access level of the database -| |dbms.servers[].databases[].databaseId |String |Unique identifier for the database -| |dbms.servers[].databases[].requestedStatus |String |Requested status of the database -| |dbms.servers[].databases[].currentStatus |String |Current status of the database -| |dbms.servers[].databases[].statusMessage |String |Status message describing the current state -| -|dbms.servers[].databases[]._default +|dbms.servers[].databases[].default |boolean |Whether this is the default database -| |dbms.servers[].databases[].home |boolean |Whether this is the home database -| |dbms.servers[].databases[].currentPrimariesCount -|long -|Current number of primary instances -| +|Integer +|Current number of primaries for this database |dbms.servers[].databases[].currentSecondariesCount -|long -|Current number of secondary instances -| +|Integer +|Current number of secondaries for this database |dbms.servers[].databases[].requestedPrimariesCount |Integer -|Requested number of primary instances -| +|Requested number of primaries for this database |dbms.servers[].databases[].requestedSecondariesCount |Integer -|Requested number of secondary instances -| +|Requested number of secondaries for this database |dbms.servers[].databases[].creationTime |long |Timestamp when the database was created -| |dbms.servers[].databases[].lastStartTime |long |Timestamp when the database was last started -| |dbms.servers[].databases[].store |String -|Store information for the database -| +|Store format of the database |dbms.servers[].databases[].writer |boolean -|Whether this instance is a writer -| +|Whether this instance is a writer for this database |dbms.servers[].databases[].lastCommittedTxn |Integer |Last committed transaction ID -| |dbms.servers[].databases[].replicationLag |Integer |Current replication lag -| +|dbms.servers[].databases[].graphCount +|GraphCount +|Current graph counts for the database +|dbms.servers[].databases[].graphCount.node_count +|Long +|Number of nodes in the graph +|dbms.servers[].databases[].graphCount.relationship_count +|Long +|Number of relationships in the graph +|dbms.servers[].databases[].graphShards +|List +|List of graph shards of this database +|dbms.servers[].databases[].propertyShards +|List +|List of property shards of this database |dbms.servers[].license |License |Main license information -| |dbms.servers[].license.type |String |Type of the license -| |dbms.servers[].license.state |String |Current state of the license -| |dbms.servers[].license.daysLeftOnTrial |Integer |Number of days remaining in trial period -| |dbms.servers[].license.totalTrialDays |Integer |Total number of days in trial period -| |dbms.servers[].bloomLicense |License |Bloom license information -| |dbms.servers[].bloomLicense.type |String |Type of the license -| |dbms.servers[].bloomLicense.state |String |Current state of the license -| |dbms.servers[].bloomLicense.daysLeftOnTrial |Integer |Number of days remaining in trial period -| |dbms.servers[].bloomLicense.totalTrialDays |Integer |Total number of days in trial period -| |dbms.servers[].gdsLicense |License |GDS license information -| |dbms.servers[].gdsLicense.type |String |Type of the license -| |dbms.servers[].gdsLicense.state |String |Current state of the license -| |dbms.servers[].gdsLicense.daysLeftOnTrial |Integer |Number of days remaining in trial period -| |dbms.servers[].gdsLicense.totalTrialDays |Integer |Total number of days in trial period -| +|dbms.servers[].plugins +|List +|List of plugins installed on the server +|dbms.servers[].plugins[].filename +|String +|Filename of the plugin +|dbms.servers[].plugins[].name +|String +|Manifest name of the plugin, if available +|dbms.servers[].plugins[].version +|String +|Manifest version of the plugin, if available +|dbms.servers[].plugins[].vendor +|String +|Manifest vendor of the plugin, if available |pluginVersion |String |Version of the fleet management plugin -| |osName |String |Operating system name -| |osVersion |String |Operating system version -| |osArch |String |Operating system architecture -| |jvmVersion |String |Java Virtual Machine version -| |jvmVendor |String |Java Virtual Machine vendor -| |=== From a656a95716181f528b76f546889288eb4470b810 Mon Sep 17 00:00:00 2001 From: Alexander Bouriakov Date: Wed, 20 Aug 2025 11:37:40 +0200 Subject: [PATCH 4/5] update --- modules/ROOT/pages/fleet-management/overview.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/ROOT/pages/fleet-management/overview.adoc b/modules/ROOT/pages/fleet-management/overview.adoc index 72ea24a5a..673b75e59 100644 --- a/modules/ROOT/pages/fleet-management/overview.adoc +++ b/modules/ROOT/pages/fleet-management/overview.adoc @@ -319,4 +319,3 @@ Message sent from the server to the Fleet Management service containing reportin |String |Java Virtual Machine vendor |=== - From b95a0864e048490c3a2f0eecaa038944e23be79e Mon Sep 17 00:00:00 2001 From: Sebastian Fabian Date: Thu, 21 Aug 2025 15:37:49 +0200 Subject: [PATCH 5/5] Reorganize and add more pages --- modules/ROOT/content-nav.adoc | 2 + modules/ROOT/pages/fleet-management/data.adoc | 322 +++++++++++++++++ .../ROOT/pages/fleet-management/overview.adoc | 333 ++---------------- .../managing-instances/self-managed.adoc | 11 + 4 files changed, 358 insertions(+), 310 deletions(-) create mode 100644 modules/ROOT/pages/fleet-management/data.adoc create mode 100644 modules/ROOT/pages/managing-instances/self-managed.adoc diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 6a9eb800a..7d6cfbd7f 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -22,6 +22,7 @@ Generic Start * Manage instances ** xref:managing-instances/instance-actions.adoc[Instance actions] ** xref:managing-instances/instance-details.adoc[Instance details] +** xref:managing-instances/self-managed.adoc[Self-managed instances] ** xref:managing-instances/secondaries.adoc[Secondaries] ** xref:managing-instances/instance-resources.adoc[Resources] ** xref:managing-instances/custom-endpoints.adoc[Custom endpoints] @@ -115,6 +116,7 @@ Generic Start * Fleet management ** xref:fleet-management/overview.adoc[Overview] +** xref:fleet-management/data.adoc[Data transparency] * Connecting applications ** xref:connecting-applications/overview.adoc[Drivers and libraries] diff --git a/modules/ROOT/pages/fleet-management/data.adoc b/modules/ROOT/pages/fleet-management/data.adoc new file mode 100644 index 000000000..1180282bb --- /dev/null +++ b/modules/ROOT/pages/fleet-management/data.adoc @@ -0,0 +1,322 @@ += Data transparency + +This document describes the data structures used in fleet management messages. + +== ConnectMessage + +Message sent from the server to the Fleet Management service to establish a connection + +[cols="1,1,1"] +|=== +|Field |Type |Description +|server_id +|String +|Unique identifier for the server +|name +|String +|Name of the server +|dbms_id +|String +|Unique identifier for the DBMS instance +|server_version +|String +|Version of the server +|project_id +|String +|Identifier for the project +|plugin_version +|String +|Version of the plugin +|build_profile +|String +|Build profile of the plugin +|=== + +== MetricsMessage + +Message sent from the server to the Fleet Management service containing metrics data + +[cols="1,1,1"] +|=== +|Field |Type |Description +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +|project_id +|String +|Identifier for the project +|dbms_id +|String +|Unique identifier for the DBMS instance +|server_id +|String +|Unique identifier for the server +|metrics +|Map> +|Map of metric names to lists of DataPoint objects. Values are dynamically populated from the Fleet Management server. +|metrics<>[].tags +|Map +|Map of string key-value pairs providing additional context for the metric +|metrics<>[].value +|Double +|Double value representing the metric measurement +|=== + +== Neo4jConfigMessage + +Message sent from the server to the Fleet Management service containing neo4j config data + +[cols="1,1,1"] +|=== +|Field |Type |Description +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +|project_id +|String +|Identifier for the project +|dbms_id +|String +|Unique identifier for the DBMS instance +|server_id +|String +|Unique identifier for the server +|neo4j_config +|Map +|Map of neo4j config names to config values. Values are dynamically populated from the Fleet Management server. +|=== + +== PingMessage + +Message sent from the server to the Fleet Management service to retrieve configuration updates + +[cols="1,1,1"] +|=== +|Field |Type |Description +|server_id +|String +|Unique identifier for the server +|server_version +|String +|Version of the server +|project_id +|String +|Identifier for the project +|=== + +== ReportingMessage + +Message sent from the server to the Fleet Management service containing reporting data + +[cols="1,1,1"] +|=== +|Field |Type |Description +|timestamp +|long +|Unix timestamp in milliseconds when the message was created +|projectId +|String +|Identifier for the project +|dbms +|Dbms +|DBMS information object +|dbms.dbmsId +|String +|Unique identifier for the DBMS instance +|dbms.serverId +|String +|Unique identifier for the server +|dbms.databases +|List +|List of database names +|dbms.edition +|String +|Edition of the DBMS (e.g., Enterprise, Community) +|dbms.packaging +|String +|Packaging of DBMS installation +|dbms.servers +|List +|List of servers in the DBMS cluster +|dbms.servers[].serverId +|String +|Unique identifier for the server +|dbms.servers[].name +|String +|Name of the server +|dbms.servers[].address +|String +|Network address of the server +|dbms.servers[].health +|String +|Current health status of the server +|dbms.servers[].state +|String +|Current state of the server +|dbms.servers[].modeConstraint +|String +|Mode constraint of the server +|dbms.servers[].version +|String +|Neo4j version of the server +|dbms.servers[].databases +|List +|List of databases hosted on this server +|dbms.servers[].databases[].name +|String +|Name of the database +|dbms.servers[].databases[].role +|String +|Role of the database in the cluster +|dbms.servers[].databases[].type +|String +|Type of the database in the cluster +|dbms.servers[].databases[].aliases +|List +|List of database aliases +|dbms.servers[].databases[].access +|String +|Access level of the database +|dbms.servers[].databases[].databaseId +|String +|Unique identifier for the database +|dbms.servers[].databases[].requestedStatus +|String +|Requested status of the database +|dbms.servers[].databases[].currentStatus +|String +|Current status of the database +|dbms.servers[].databases[].statusMessage +|String +|Status message describing the current state +|dbms.servers[].databases[].default +|boolean +|Whether this is the default database +|dbms.servers[].databases[].home +|boolean +|Whether this is the home database +|dbms.servers[].databases[].currentPrimariesCount +|Integer +|Current number of primaries for this database +|dbms.servers[].databases[].currentSecondariesCount +|Integer +|Current number of secondaries for this database +|dbms.servers[].databases[].requestedPrimariesCount +|Integer +|Requested number of primaries for this database +|dbms.servers[].databases[].requestedSecondariesCount +|Integer +|Requested number of secondaries for this database +|dbms.servers[].databases[].creationTime +|long +|Timestamp when the database was created +|dbms.servers[].databases[].lastStartTime +|long +|Timestamp when the database was last started +|dbms.servers[].databases[].store +|String +|Store format of the database +|dbms.servers[].databases[].writer +|boolean +|Whether this instance is a writer for this database +|dbms.servers[].databases[].lastCommittedTxn +|Integer +|Last committed transaction ID +|dbms.servers[].databases[].replicationLag +|Integer +|Current replication lag +|dbms.servers[].databases[].graphCount +|GraphCount +|Current graph counts for the database +|dbms.servers[].databases[].graphCount.node_count +|Long +|Number of nodes in the graph +|dbms.servers[].databases[].graphCount.relationship_count +|Long +|Number of relationships in the graph +|dbms.servers[].databases[].graphShards +|List +|List of graph shards of this database +|dbms.servers[].databases[].propertyShards +|List +|List of property shards of this database +|dbms.servers[].license +|License +|Main license information +|dbms.servers[].license.type +|String +|Type of the license +|dbms.servers[].license.state +|String +|Current state of the license +|dbms.servers[].license.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +|dbms.servers[].license.totalTrialDays +|Integer +|Total number of days in trial period +|dbms.servers[].bloomLicense +|License +|Bloom license information +|dbms.servers[].bloomLicense.type +|String +|Type of the license +|dbms.servers[].bloomLicense.state +|String +|Current state of the license +|dbms.servers[].bloomLicense.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +|dbms.servers[].bloomLicense.totalTrialDays +|Integer +|Total number of days in trial period +|dbms.servers[].gdsLicense +|License +|GDS license information +|dbms.servers[].gdsLicense.type +|String +|Type of the license +|dbms.servers[].gdsLicense.state +|String +|Current state of the license +|dbms.servers[].gdsLicense.daysLeftOnTrial +|Integer +|Number of days remaining in trial period +|dbms.servers[].gdsLicense.totalTrialDays +|Integer +|Total number of days in trial period +|dbms.servers[].plugins +|List +|List of plugins installed on the server +|dbms.servers[].plugins[].filename +|String +|Filename of the plugin +|dbms.servers[].plugins[].name +|String +|Manifest name of the plugin, if available +|dbms.servers[].plugins[].version +|String +|Manifest version of the plugin, if available +|dbms.servers[].plugins[].vendor +|String +|Manifest vendor of the plugin, if available +|pluginVersion +|String +|Version of the fleet management plugin +|osName +|String +|Operating system name +|osVersion +|String +|Operating system version +|osArch +|String +|Operating system architecture +|jvmVersion +|String +|Java Virtual Machine version +|jvmVendor +|String +|Java Virtual Machine vendor +|=== + diff --git a/modules/ROOT/pages/fleet-management/overview.adoc b/modules/ROOT/pages/fleet-management/overview.adoc index 673b75e59..c439b4dc2 100644 --- a/modules/ROOT/pages/fleet-management/overview.adoc +++ b/modules/ROOT/pages/fleet-management/overview.adoc @@ -1,321 +1,34 @@ -= Fleet Management Plugin Documentation += Overview -This document describes the data structures used in fleet management messages. +Get an enterprise-wide view of all your Neo4j systems—Aura-managed or self-managed. -== ConnectMessage +For enterprise customers operating in hybrid environments, it’s common to have a mix of *Aura-managed* and *self-managed* Neo4j deployments. By integrating self-managed deployments into the Aura Console, organizations can simplify operations, reduce overhead, and plan for full migration when ready. -Message sent from the server to the Fleet Management service to establish a connection +== *Centralized management* +Register self-managed Neo4j deployments directly in the Aura Console to: -[cols="1,1,1"] -|=== -|Field |Type |Description -|server_id -|String -|Unique identifier for the server -|name -|String -|Name of the server -|dbms_id -|String -|Unique identifier for the DBMS instance -|server_version -|String -|Version of the server -|project_id -|String -|Identifier for the project -|plugin_version -|String -|Version of the plugin -|build_profile -|String -|Build profile of the plugin -|=== +* Monitor and manage all Neo4j databases across your organization in one place +* Monitor health and performance metrics +* Run Cypher queries, explore graphs, and view dashboards -== MetricsMessage +== Registering a self-managed Neo4j instance in Aura -Message sent from the server to the Fleet Management service containing metrics data +To register your self-managed instance: -[cols="1,1,1"] -|=== -|Field |Type |Description -|timestamp -|long -|Unix timestamp in milliseconds when the message was created -|project_id -|String -|Identifier for the project -|dbms_id -|String -|Unique identifier for the DBMS instance -|server_id -|String -|Unique identifier for the server -|metrics -|Map> -|Map of metric names to lists of DataPoint objects. Values are dynamically populated from the Fleet Management server. -|metrics<>[].tags -|Map -|Map of string key-value pairs providing additional context for the metric -|metrics<>[].value -|Double -|Double value representing the metric measurement -|=== +. Log into the Aura Console +. Navigate to [location TBD] +. Install the plugin and follow the steps provided -== Neo4jConfigMessage +== Then you will be able to: -Message sent from the server to the Fleet Management service containing neo4j config data +* Monitor health and performance metrics +* Run Cypher queries, explore graphs, and view dashboards +* Use the same tools across Aura and self-managed deployments +* Access powerful tools like *Query* and *Explore*—even for self-hosted databases -[cols="1,1,1"] -|=== -|Field |Type |Description -|timestamp -|long -|Unix timestamp in milliseconds when the message was created -|project_id -|String -|Identifier for the project -|dbms_id -|String -|Unique identifier for the DBMS instance -|server_id -|String -|Unique identifier for the server -|neo4j_config -|Map -|Map of neo4j config names to config values. Values are dynamically populated from the Fleet Management server. -|=== +== Hybrid Enterprise Support -== PingMessage - -Message sent from the server to the Fleet Management service to retrieve configuration updates - -[cols="1,1,1"] -|=== -|Field |Type |Description -|server_id -|String -|Unique identifier for the server -|server_version -|String -|Version of the server -|project_id -|String -|Identifier for the project -|=== - -== ReportingMessage - -Message sent from the server to the Fleet Management service containing reporting data - -[cols="1,1,1"] -|=== -|Field |Type |Description -|timestamp -|long -|Unix timestamp in milliseconds when the message was created -|projectId -|String -|Identifier for the project -|dbms -|Dbms -|DBMS information object -|dbms.dbmsId -|String -|Unique identifier for the DBMS instance -|dbms.serverId -|String -|Unique identifier for the server -|dbms.databases -|List -|List of database names -|dbms.edition -|String -|Edition of the DBMS (e.g., Enterprise, Community) -|dbms.packaging -|String -|Packaging of DBMS installation -|dbms.servers -|List -|List of servers in the DBMS cluster -|dbms.servers[].serverId -|String -|Unique identifier for the server -|dbms.servers[].name -|String -|Name of the server -|dbms.servers[].address -|String -|Network address of the server -|dbms.servers[].health -|String -|Current health status of the server -|dbms.servers[].state -|String -|Current state of the server -|dbms.servers[].modeConstraint -|String -|Mode constraint of the server -|dbms.servers[].version -|String -|Neo4j version of the server -|dbms.servers[].databases -|List -|List of databases hosted on this server -|dbms.servers[].databases[].name -|String -|Name of the database -|dbms.servers[].databases[].role -|String -|Role of the database in the cluster -|dbms.servers[].databases[].type -|String -|Type of the database in the cluster -|dbms.servers[].databases[].aliases -|List -|List of database aliases -|dbms.servers[].databases[].access -|String -|Access level of the database -|dbms.servers[].databases[].databaseId -|String -|Unique identifier for the database -|dbms.servers[].databases[].requestedStatus -|String -|Requested status of the database -|dbms.servers[].databases[].currentStatus -|String -|Current status of the database -|dbms.servers[].databases[].statusMessage -|String -|Status message describing the current state -|dbms.servers[].databases[].default -|boolean -|Whether this is the default database -|dbms.servers[].databases[].home -|boolean -|Whether this is the home database -|dbms.servers[].databases[].currentPrimariesCount -|Integer -|Current number of primaries for this database -|dbms.servers[].databases[].currentSecondariesCount -|Integer -|Current number of secondaries for this database -|dbms.servers[].databases[].requestedPrimariesCount -|Integer -|Requested number of primaries for this database -|dbms.servers[].databases[].requestedSecondariesCount -|Integer -|Requested number of secondaries for this database -|dbms.servers[].databases[].creationTime -|long -|Timestamp when the database was created -|dbms.servers[].databases[].lastStartTime -|long -|Timestamp when the database was last started -|dbms.servers[].databases[].store -|String -|Store format of the database -|dbms.servers[].databases[].writer -|boolean -|Whether this instance is a writer for this database -|dbms.servers[].databases[].lastCommittedTxn -|Integer -|Last committed transaction ID -|dbms.servers[].databases[].replicationLag -|Integer -|Current replication lag -|dbms.servers[].databases[].graphCount -|GraphCount -|Current graph counts for the database -|dbms.servers[].databases[].graphCount.node_count -|Long -|Number of nodes in the graph -|dbms.servers[].databases[].graphCount.relationship_count -|Long -|Number of relationships in the graph -|dbms.servers[].databases[].graphShards -|List -|List of graph shards of this database -|dbms.servers[].databases[].propertyShards -|List -|List of property shards of this database -|dbms.servers[].license -|License -|Main license information -|dbms.servers[].license.type -|String -|Type of the license -|dbms.servers[].license.state -|String -|Current state of the license -|dbms.servers[].license.daysLeftOnTrial -|Integer -|Number of days remaining in trial period -|dbms.servers[].license.totalTrialDays -|Integer -|Total number of days in trial period -|dbms.servers[].bloomLicense -|License -|Bloom license information -|dbms.servers[].bloomLicense.type -|String -|Type of the license -|dbms.servers[].bloomLicense.state -|String -|Current state of the license -|dbms.servers[].bloomLicense.daysLeftOnTrial -|Integer -|Number of days remaining in trial period -|dbms.servers[].bloomLicense.totalTrialDays -|Integer -|Total number of days in trial period -|dbms.servers[].gdsLicense -|License -|GDS license information -|dbms.servers[].gdsLicense.type -|String -|Type of the license -|dbms.servers[].gdsLicense.state -|String -|Current state of the license -|dbms.servers[].gdsLicense.daysLeftOnTrial -|Integer -|Number of days remaining in trial period -|dbms.servers[].gdsLicense.totalTrialDays -|Integer -|Total number of days in trial period -|dbms.servers[].plugins -|List -|List of plugins installed on the server -|dbms.servers[].plugins[].filename -|String -|Filename of the plugin -|dbms.servers[].plugins[].name -|String -|Manifest name of the plugin, if available -|dbms.servers[].plugins[].version -|String -|Manifest version of the plugin, if available -|dbms.servers[].plugins[].vendor -|String -|Manifest vendor of the plugin, if available -|pluginVersion -|String -|Version of the fleet management plugin -|osName -|String -|Operating system name -|osVersion -|String -|Operating system version -|osArch -|String -|Operating system architecture -|jvmVersion -|String -|Java Virtual Machine version -|jvmVendor -|String -|Java Virtual Machine vendor -|=== +* *Continuous feature updates* +* *Unified experience* across environments +* *Transparent migration*: Move to fully managed Aura at your own pace +* *Retain full data visibility and access* via the Aura Console throughout the process diff --git a/modules/ROOT/pages/managing-instances/self-managed.adoc b/modules/ROOT/pages/managing-instances/self-managed.adoc new file mode 100644 index 000000000..dc19afd35 --- /dev/null +++ b/modules/ROOT/pages/managing-instances/self-managed.adoc @@ -0,0 +1,11 @@ +[[self-managed-instances]] += Self-managed instances +:description: This page describes the self-managed instance overview. + +From the *Self-managed* tab, you can add and monitor your self-managed Neo4j deployments. Even though these instances are not hosted by Neo4j, you can still still connect to them from the Aura console. + +This functionality is exhaustively documented in the xref:fleet-management/overview.adoc[Fleet management] section. + +== Card view + +Write stuff here. \ No newline at end of file