JanusGraph / JanusGraph/janusgraph

Improve error message for FIXED config options

Open
#3,206 0 comments 0 reactions 0 assignees View on GitHub
area/core
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

**Describe the feature:**
When someone tries to change a config option which has the mutability level `FIXED`, then this error message is logged:

> Local setting graph.set-vertex-id=true (Type: FIXED) is overridden by globally managed value (false). Use the ManagementSystem interface instead of the local configuration to control this setting

However, `FIXED` options cannot be changed at all in an existing cluster [as the docs state](https://docs.janusgraph.org/v0.6/configs/configuration-reference/):

> FIXED: Like GLOBAL, but the value cannot be changed once the JanusGraph cluster is initialized.

It would be good to state this clearly in the error message instead of suggesting that users try the `ManagementSystem` instead which won't work.

This was just described on Discord and [StackOverflow](https://stackoverflow.com/q/73720924/6753576).

Contributor guide

Open the contributing guide

Research direction

Start by searching the Java codebase for the logged message beginning "Local setting" and trace how FIXED mutability is handled. Update the message so it explains that the option cannot be changed after cluster initialization, rather than directing users to the ManagementSystem interface; done means the resulting error is accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
databases
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.