Introduce API Metrics/Telemetry #1142
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Neo4j would like to be able to track more information about driver apis usage, so that smarter decisions can be made on improving drivers and their stack.
The collection of metrics must be respectful of users.
Thus, the collected metrics should be:
1. impossible to be tied back the customer or user
2. transparent to the users that inspect
3. restrained to required metrics
The metric collection is disabled by default in Neo4j.
It can be enabled in the server by setting `server.bolt.telemetry.enabled` to `true`.
However, the metric collection is enabled by default in the drivers.
It can be disabled in the driver by configuring the driver with `telemetryDisabled` to `true`. Default: `false`.
**Metrics are only collected when enabled both in server and driver instances.**
Disabling metrics on driver:
```typescript
const driver = neo4j.driver(host, auth, { telemetryDisabled: true })
```
robsdedude
reviewed
Sep 22, 2023
packages/bolt-connection/test/bolt/__snapshots__/bolt-protocol-v5x4.test.js.snap
Outdated
Show resolved
Hide resolved
packages/neo4j-driver/test/internal/transaction-executor.test.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Robsdedude <[email protected]>
The problem is in that point we don't if the failure is a connection failure. So, change the error type can break the retry.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Neo4j would like to be able to track more information about driver apis usage, so that smarter decisions can be made on improving drivers and their stack.
The collection of metrics must be respectful of users. Thus, the collected metrics are:
The metric collection is disabled by default in Neo4j. It can be enabled in the server by setting
server.bolt.telemetry.enabledtotrue.However, the metric collection is enabled by default in the drivers. It can be disabled in the driver by configuring the driver with
telemetryDisabledtotrue. Default:false.Metrics are only collected when enabled both in server and driver instances.
Disabling metrics on driver: