Skip to content

Add support for Bolt 5.4 an API telemetry #965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2023

Conversation

robsdedude
Copy link
Member

@robsdedude robsdedude commented Sep 20, 2023

Starting with Bolt 5.4, the driver will, by default, send anonymous API usage statistics to the server if requested.

The driver configuration telemetry_disabled=True can be used to disable this.

import neo4j

with neo4j.GraphDatabase.driver(..., telemetry_disabled=True) as driver:
    ...

The driver transmits the following information:

  • Every time one of the following APIs is used to execute a query (for the first time), the server is informed of this (without any further information like arguments, client identifiers, etc.):
    • driver.execute_query
    • session.begin_transaction
    • session.execute_read, session.execute_write
    • session.run
    • the async counterparts of the above methods

Depends on:

Starting with Bolt 5.4, the driver will, by default, send anonymous API usage
statistics to the server if requested.

The driver configuration `telemetry_disabled=True` can be used to disable this.

```python
import neo4j

with neo4j.GraphDatabase.driver(..., telemetry_disabled=True) as driver:
    ...
```

The driver transmits the following information:

* Every time one of the following APIs is used to execute a query
  (for the first time), the server is informed of this
  (without any further information like arguments, client identifiers, etc.):
  * `driver.execute_query`
  * `session.begin_transaction`
  * `session.execute_read`, `session.execute_write`
  * `session.run`
  * the async counterparts of the above methods
Copy link
Contributor

@StephenCathcart StephenCathcart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! :shipit:

@robsdedude robsdedude merged commit fe37b7d into neo4j:5.0 Sep 25, 2023
@robsdedude robsdedude deleted the api-metrics branch September 25, 2023 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants