Data transparency

This page describes the data structures used in Fleet Manager messages.

ConnectMessage

Message sent from the server to the Fleet Manager service to establish a connection.

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

server_version

String

Version of the server

project_id

String

Identifier for the project

plugin_version

String

Version of the Fleet Manager module

build_profile

String

Build profile of the Fleet Manager module

MetricsMessage

Message sent from the server to the Fleet Manager service containing metrics data.

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

server_id

String

Unique identifier for the server

metrics

Map<String, Collection<DataPoint>>

Map of metric names to lists of DataPoint objects. Values are dynamically populated from the Fleet Manager server.

metrics<>[].tags

Map<String, String>

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 Manager service containing neo4j configuration data.

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

server_id

String

Unique identifier for the server

neo4j_config

Map<String, Object>

Map of neo4j config names to config values. Values are dynamically populated from the Fleet Manager service.

PingMessage

Message sent from the server to the Fleet Manager service to retrieve configuration updates.

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

QueryReportMessage

Message sent from the server to the Fleet Manager service containing aggregated query data. Only sent if query logging is enabled explicitly through Aura Console.

Field Type Description

fromTimestamp

long

Unix timestamp in milliseconds from the first query in the set

toTimestamp

long

Unix timestamp in milliseconds to the last query in the set

project_id

String

Identifier for the project

dbms_id

String

Unique identifier for the DBMS

server_id

String

Unique identifier for the server

queries

Collection<AggregatedQueryData>

Aggregated query data

queries[]

AggregatedQueryData

A specific query in the set

queries[].query

String

Obfuscated query text

queries[].success

boolean

Whether the query was successful

queries[].gqlError

SimplifiedGqlError

GQL error object (if query failed)

queries[].gqlError.cause

SimplifiedGqlError (recursive)

Nested error (if any)

queries[].gqlError.classification

String

Error classification

queries[].gqlError.statusDescription

String

Error message description

queries[].gqlError.gqlStatus

String

GQL status code

queries[].queryLanguage

String

Language of the query

queries[].meta

QueryAggregationMeta

Metadata representing the aggregated executions of this query

queries[].meta.count

long

The number of recorded executions of the query

queries[].meta.minElapsedMs

long

The fastest execution of the query

queries[].meta.maxElapsedMs

long

The slowest execution of the query

queries[].meta.minTimestamp

long

The earliest execution of the query within this report

queries[].meta.maxTimestamp

long

The latest execution of the query within this report

queries[].meta.databases

Collection<String>

List of databases this query was executed on

queries[].meta.applications

Collection<String>

List of applications from which the query originated

queries[].meta.types

Collection<String>

List of initiation types of the query

queries[].meta.users

Collection<String>

List of users that executed the query

queries[].meta.avgElapsedMs

double

The average duration

queries[].meta.avgWaitTimeMs

double

The average wait time

queries[].meta.avgPageHits

double

The average number of page hits

queries[].meta.avgPageFaults

double

The average number of page faults

queries[].meta.avgAllocatedBytes

double

The average number of allocated bytes

ReportingMessage

Message sent from the server to the Fleet Manager service containing reporting data.

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

dbms.serverId

String

Unique identifier for the server

dbms.databases

Collection<String>

List of database names

dbms.edition

String

Edition of the DBMS (e.g., Enterprise, Community)

dbms.packaging

String

Packaging of DBMS installation

dbms.servers

Collection<Server>

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

Collection<Database>

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

Collection<String>

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

Collection<String>

List of graph shards of this database

dbms.servers[].databases[].propertyShards

Collection<String>

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

Collection<Plugin>

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 Manager module

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

SecurityLogsReportMessage

Message sent from the server to the Fleet Manager service containing security logs data.

Field Type Description

from_timestamp

long

Unix timestamp in milliseconds from the first log in the set

to_timestamp

long

Unix timestamp in milliseconds to the last log in the set

project_id

String

Identifier for the project

dbms_id

String

Unique identifier for the DBMS

server_id

String

Unique identifier for the server

logs

Collection<Value>

Security logs data

logs[].meta

Meta

Aggregated metadata for the log event

logs[].meta.count

int

Security logs count for unique set of log fields

logs[].meta.databases

Collection<String>

Databases in context of the log event occurred

logs[].meta.authenticatedUsers

Collection<String>

Users authenticated to the Database for execution of the process that caused the log event

logs[].meta.sources

Collection<String>

Connection information for the log event sources

logs[].message

String

Log event main message

logs[].level

String

Severity level of the log event

logs[].executingUser

String

User associated with the execution of the process that caused the log event