Data transparency
This page describes the data structures used in fleet management messages.
ConnectMessage
Message sent from the plugin to the Fleet Management service to establish a connection.
Field | Type | Description |
---|---|---|
|
String |
Unique identifier for the server |
|
String |
Name of the server |
|
String |
Unique identifier for the DBMS |
|
String |
Version of the server |
|
String |
Identifier for the project |
|
String |
Version of the plugin |
|
String |
Build profile of the plugin |
MetricsMessage
Message sent from the plugin to the Fleet Management service containing metrics data.
Field | Type | Description |
---|---|---|
|
long |
Unix timestamp in milliseconds when the message was created |
|
String |
Identifier for the project |
|
String |
Unique identifier for the DBMS |
|
String |
Unique identifier for the server |
|
Map<String, List<DataPoint>> |
Map of metric names to lists of DataPoint objects. Values are dynamically populated from the Fleet Management server. |
|
Map<String, String> |
Map of string key-value pairs providing additional context for the metric |
|
Double |
Double value representing the metric measurement |
Neo4jConfigMessage
Message sent from the plugin to the Fleet Management service containing neo4j configuration data.
Field | Type | Description |
---|---|---|
|
long |
Unix timestamp in milliseconds when the message was created |
|
String |
Identifier for the project |
|
String |
Unique identifier for the DBMS |
|
String |
Unique identifier for the server |
|
Map<String, Object> |
Map of neo4j config names to config values. Values are dynamically populated from the Fleet Management server. |
PingMessage
Message sent from the plugin to the Fleet Management service to retrieve configuration updates.
Field | Type | Description |
---|---|---|
|
String |
Unique identifier for the server |
|
String |
Version of the server |
|
String |
Identifier for the project |
ReportingMessage
Message sent from the plugin to the Fleet Management service containing reporting data.
Field | Type | Description |
---|---|---|
|
long |
Unix timestamp in milliseconds when the message was created |
|
String |
Identifier for the project |
|
Dbms |
DBMS information object |
|
String |
Unique identifier for the DBMS |
|
String |
Unique identifier for the server |
|
List<String> |
List of database names |
|
String |
Edition of the DBMS (e.g., Enterprise, Community) |
|
String |
Packaging of DBMS installation |
|
List<Server> |
List of servers in the DBMS cluster |
|
String |
Unique identifier for the server |
|
String |
Name of the server |
|
String |
Network address of the server |
|
String |
Current health status of the server |
|
String |
Current state of the server |
|
String |
Mode constraint of the server |
|
String |
Neo4j version of the server |
|
List<Database> |
List of databases hosted on this server |
|
String |
Name of the database |
|
String |
Role of the database in the cluster |
|
String |
Type of the database in the cluster |
|
List<String> |
List of database aliases |
|
String |
Access level of the database |
|
String |
Unique identifier for the database |
|
String |
Requested status of the database |
|
String |
Current status of the database |
|
String |
Status message describing the current state |
|
boolean |
Whether this is the default database |
|
boolean |
Whether this is the home database |
|
Integer |
Current number of primaries for this database |
|
Integer |
Current number of secondaries for this database |
|
Integer |
Requested number of primaries for this database |
|
Integer |
Requested number of secondaries for this database |
|
long |
Timestamp when the database was created |
|
long |
Timestamp when the database was last started |
|
String |
Store format of the database |
|
boolean |
Whether this instance is a writer for this database |
|
Integer |
Last committed transaction ID |
|
Integer |
Current replication lag |
|
GraphCount |
Current graph counts for the database |
|
Long |
Number of nodes in the graph |
|
Long |
Number of relationships in the graph |
|
List<String> |
List of graph shards of this database |
|
List<String> |
List of property shards of this database |
|
License |
Main license information |
|
String |
Type of the license |
|
String |
Current state of the license |
|
Integer |
Number of days remaining in trial period |
|
Integer |
Total number of days in trial period |
|
License |
Bloom license information |
|
String |
Type of the license |
|
String |
Current state of the license |
|
Integer |
Number of days remaining in trial period |
|
Integer |
Total number of days in trial period |
|
License |
GDS license information |
|
String |
Type of the license |
|
String |
Current state of the license |
|
Integer |
Number of days remaining in trial period |
|
Integer |
Total number of days in trial period |
|
List<Plugin> |
List of plugins installed on the server |
|
String |
Filename of the plugin |
|
String |
Manifest name of the plugin, if available |
|
String |
Manifest version of the plugin, if available |
|
String |
Manifest vendor of the plugin, if available |
|
String |
Version of the fleet management plugin |
|
String |
Operating system name |
|
String |
Operating system version |
|
String |
Operating system architecture |
|
String |
Java Virtual Machine version |
|
String |
Java Virtual Machine vendor |