Skip to content

Add new configuration settings and update the default of server.metrics.filter #2180

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.

Sign up for GitHub

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 7 commits into from
Mar 20, 2025
Merged

Add new configuration settings and update the default of server.metrics.filter #2180

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1136b8a
Add new configuration settings for 2025.03
NataliaIvakina Mar 11, 2025
8e41f5d
Add valid values
NataliaIvakina Mar 11, 2025
5a67424
Update a valid value
NataliaIvakina Mar 12, 2025
0b39f70
Fix the test
NataliaIvakina Mar 12, 2025
9cca1f5
Apply suggestions from code review
NataliaIvakina Mar 19, 2025
5dd08b7
Update modules/ROOT/pages/configuration/configuration-settings.adoc
NataliaIvakina Mar 19, 2025
2ca7b8b
Update modules/ROOT/pages/configuration/configuration-settings.adoc
NataliaIvakina Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
** xref:configuration/dynamic-settings.adoc[]
** xref:configuration/configuration-settings.adoc[]
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
*** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings]
*** xref:configuration/configuration-settings.adoc#_cluster_settings[Cluster settings]
*** xref:configuration/configuration-settings.adoc#_connection_settings[Connection settings]
*** xref:configuration/configuration-settings.adoc#_cypher_settings[Cypher settings]
Expand Down
86 changes: 85 additions & 1 deletion modules/ROOT/pages/configuration/configuration-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,73 @@ a|An integer.
m|+++600+++
|===

== Cloud storage integration settings

Configuration settings enable custom cloud storage and host authority endpoints.

[role=label--enterprise-edition label--new-2025.03]
[[config_dbms.integrations.cloud_storage.azb.blob_endpoint_suffix]]
=== `dbms.integrations.cloud_storage.azb.blob_endpoint_suffix`

.dbms.integrations.cloud_storage.azb.blob_endpoint_suffix
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Azure blob storage endpoint suffix. You need to change this if you are not using Azure public cloud (e.g., if you are using Azure Government).
|Valid values
a|A string.
|Default value
m|+++blob.core.windows.net+++
|===


[role=label--enterprise-edition label--new-2025.03]
[[config_dbms.integrations.cloud_storage.azb.authority_endpoint]]
=== `dbms.integrations.cloud_storage.azb.authority_endpoint`

.dbms.integrations.cloud_storage.azb.authority_endpoint
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Azure authority host endpoint (only required for certain methods of authentication, it should be specified in its full form - e.g., https://login.microsoftonline.com).
|Valid values
a|A string.
|Default value
m|+++b''+++
Copy link
Contributor

@docrozza docrozza Mar 19, 2025

Choose a reason for hiding this comment

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

this looks weird on the page

Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Mar 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I took this from the test results. We're tied to the code here, and users will see the same when they run 'SHOW SETTINGS' cmd.

Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Mar 19, 2025

Choose a reason for hiding this comment

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

https://live.neo4j-build.io/buildConfiguration/Documentation_Operations_Testing_ConfigurationSettingsPRs/23402203?showLog=23402203_6382_6173.6384&logFilter=debug&logView=flowAware

Copy link
Contributor

@docrozza docrozza Mar 19, 2025

Choose a reason for hiding this comment

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

Th actual AzbSettings has a blank string so that operations/test-config-settings.py:60 is doing something weird

    @Description(
            "Azure authority host endpoint (only required for certain methods of authentication, it should be specified in its full form - e.g., https://login.microsoftonline.com)")
    public static final Setting<String> authority_endpoint = newBuilder(
                    "dbms.integrations.cloud_storage.azb.authority_endpoint", STRING, "")
            .build();

Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Mar 19, 2025

Choose a reason for hiding this comment

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

yep, you're right, the test is wrong 😄. The default has to be " ". I tested this in Neo4j 2025.03

|===


[role=label--enterprise-edition label--new-2025.03]
[[config_dbms.integrations.cloud_storage.gs.project_id]]
=== `dbms.integrations.cloud_storage.gs.project_id`

.dbms.integrations.cloud_storage.gs.project_id
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|Project ID of the Google storage bucket(s) to connect to, falling back to the value found by their SDK.
|Valid values
a|A string.
|Default value
m|++++++
|===


[role=label--enterprise-edition label--new-2025.03]
[[config_dbms.integrations.cloud_storage.s3.target_throughput_gbps]]
=== `dbms.integrations.cloud_storage.s3.target_throughput_gbps`

.dbms.integrations.cloud_storage.s3.target_throughput_gbps
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|The target throughput for transfer requests. Higher value means more connections will be established with S3. It's recommended to set it to the maximum network bandwidth on the host that the application is running on. The default is `10.0`, but when running on EC2 instances, this value can often be set much higher (being specific to the EC2 instance type).
|Valid values
a|A double.
|Default value
m|+++10.0+++
|===


== Cluster settings

Expand Down Expand Up @@ -1864,6 +1931,23 @@ m|+++0.75+++
|===


[role=label--dynamic label--new-2025.03]
[[config_dbms.cypher.transactions.default_subquery_retry_timeout]]
=== `dbms.cypher.transactions.default_subquery_retry_timeout`

.dbms.cypher.transactions.default_subquery_retry_timeout
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
|===
|Description
a|The default maximum amount of time to attempt retries of a subquery transaction that fails with a transient error in a query with a `CALL () { ... } IN TRANSACTIONS ... ON ERROR RETRY ...` clause. This setting is only used when no retry timeout is explicitly specified in the query. E.g. `CALL () { ... } IN TRANSACTIONS ... ON ERROR RETRY FOR 10 SECONDS` would override this setting with a 10 second retry timeout for that particular query.
|Valid values
a|A duration (Valid units are: ns, μs, ms, s, m, h and d; default unit is s).
|Default value
m|+++30s+++
|===



[role=label--enterprise-edition]
[[config_server.cypher.parallel.worker_limit]]
=== `server.cypher.parallel.worker_limit`
Expand Down Expand Up @@ -3006,7 +3090,7 @@ a|Specifies which metrics should be enabled by using a comma separated list of g
|Valid values
a|A comma-separated list where each element is A simple globbing pattern that can use `*` and `?`..
|Default value
m|+++*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.raft.is_leader,*cluster.raft.last_leader_message,*cluster.raft.replication_attempt,*cluster.raft.replication_fail,*cluster.raft.last_applied,*cluster.raft.last_appended,*cluster.raft.append_index,*cluster.raft.commit_index,*cluster.raft.applied_index,*cluster.internal.discovery.memberset.left,*cluster.internal.discovery.crdt.gossip_id_data.size,*cluster.internal.discovery.crdt.server_data.size,*cluster.internal.discovery.crdt.database_data.size,*cluster.internal.discovery.crdt.leader_data.size,*cluster.internal.discovery.crdt.total_merge_operations,*cluster.internal.discovery.crdt.total_update_operations,*cluster.internal.discovery.gossip.incoming_queue_size,*cluster.internal.discovery.gossip.total_received_data,*cluster.internal.discovery.gossip.total_sent_data,*cluster.internal.discovery.gossip.uncontactable_members_exist,*check_point.*,*cypher.replan_events,*cypher.cache*,*ids_in_use*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*,*protocol*+++
m|+++*bolt.connections*,*bolt.messages_received*,*bolt.messages_started*,*dbms.pool.bolt.free,*dbms.pool.bolt.total_size,*dbms.pool.bolt.total_used,*dbms.pool.bolt.used_heap,*cluster.raft.is_leader,*cluster.raft.last_leader_message,*cluster.raft.replication_attempt,*cluster.raft.replication_fail,*cluster.raft.last_applied,*cluster.raft.last_appended,*cluster.raft.append_index,*cluster.raft.commit_index,*cluster.raft.applied_index,*cluster.internal.discovery.memberset.left,*cluster.internal.discovery.crdt.gossip_id_data.size,*cluster.internal.discovery.crdt.server_data.size,*cluster.internal.discovery.crdt.database_data.size,*cluster.internal.discovery.crdt.leader_data.size,*cluster.internal.discovery.crdt.total_merge_operations,*cluster.internal.discovery.crdt.total_update_operations,*cluster.internal.discovery.gossip.incoming_queue_size,*cluster.internal.discovery.gossip.total_received_data,*cluster.internal.discovery.gossip.total_sent_data,*cluster.internal.discovery.gossip.uncontactable_members_exist,*check_point.*,*cypher.replan_events,*cypher.cache*,*ids_in_use*,*.neo4j.count.*,*pool.transaction.*.total_used,*pool.transaction.*.used_heap,*pool.transaction.*.used_native,*store.size*,*transaction.active_read,*transaction.active_write,*transaction.committed*,*transaction.last_committed_tx_id,*transaction.peak_concurrent,*transaction.rollbacks*,*page_cache.hit*,*page_cache.page_faults,*page_cache.usage_ratio,*vm.file.descriptors.count,*vm.gc.time.*,*vm.heap.used,*vm.memory.buffer.direct.used,*vm.memory.pool.g1_eden_space,*vm.memory.pool.g1_old_gen,*vm.pause_time,*vm.thread*,*db.query.execution*,*protocol*+++
|===


Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/configuration/dynamic-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ RETURN name
| "db.tx_log.rotation.size" |
| "dbms.cluster.network.connect_timeout" |
| "dbms.cypher.render_plan_description" |
| "dbms.cypher.transactions.default_subquery_retry_timeout" |
| "dbms.memory.transaction.total.max" |
| "dbms.routing.client_side.enforce_for_domains" |
| "dbms.routing.reads_on_writers_enabled" |
Expand Down