fix(dist): remove confusing actuator config that doesn't work #12205
Conversation
This file contains 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
This removes two properties from our default properties because they are confusing and did not work as expected. `management.endpoint.<id>.enabled` appears to only work for built-in actuators and not for our custom ones.
Test Results1 047 files ± 0 1 047 suites ±0 1h 56m 58s ⏱️ - 3m 42s Results for commit ad07619. ± Comparison against base commit 705712c. This pull request removes 451 and adds 810 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
deepthidevaki
approved these changes
Apr 3, 2023
There was a problem hiding this comment.
💯 Thanks for finding this issue.
Should we also remove param enableByDefault ?https://github.com/camunda/zeebe/blob/6d90738510da7327f8dc9fd7edc354f39ea37663/dist/src/main/java/io/camunda/zeebe/shared/management/BackupEndpoint.java#L43 ? It also doesn't seems to have any impact.
|
@deepthidevaki Oh right, good point 👍 |
|
bors r+ |
ghost
pushed a commit
that referenced
this pull request
Apr 3, 2023
12205: fix(dist): remove confusing actuator config that doesn't work r=oleschoenburg a=oleschoenburg This removes two properties from our default properties because they are confusing and did not work as expected. `management.endpoint.<id>.enabled` appears to only work for built-in actuators and not for our custom ones. This is not new and I suspect that this never worked as expected. For 8.1 we can see that the backup actuator was available even when it was [supposed to be disabled](https://github.com/camunda/zeebe/blob/clients/go/v8.1.0/dist/src/main/resources/application.properties#L30) by default: ```shell $ docker run --rm -p 9600:9600 camunda/zeebe:8.1.0 $ curl localhost:9600/actuator | jq '._links."backups-id"' { "href": "http://localhost:9600/actuator/backups/{id}", "templated": true } ``` Similar for the partitions endpoint on 1.3 which was supposed to be enabled by default but should be disabled when setting `MANAGEMENT_ENDPOINTS_PARTITIONS_ENABLED=false`: ```shell $ docker run --rm -p 9600:9600 -e MANAGEMENT_ENDPOINTS_PARTITIONS_ENABLED=false camunda/zeebe:1.3.0 $ curl localhost:9600/actuator | jq '._links.partitions' { "href": "http://localhost:9600/actuator/partitions", "templated": false } ``` Here we can see that this endpoint exists anyway. I can't find any references to this but I suspect that the enable flags only work for built-in actuators. We can still control which actuators are available by configuring `MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE` which actually does work as expected. Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
|
bors r- |
|
Canceled. |
Setting this annotation value apparently has no effect so we remove it here to avoid confusion.
lenaschoenburg
force-pushed
the
os-remove-broken-endpoint-config
branch
from
92dfbbd to
b135979
Compare
|
bors r+ |
|
@oleschoenburg We should also backport this to release branch. |
lenaschoenburg
force-pushed
the
os-remove-broken-endpoint-config
branch
from
b135979 to
ad07619
Compare
|
Canceled. |
|
bors r+ |
|
Build succeeded: |
ghost
merged commit 
|
Successfully created backport PR for |
ghost
pushed a commit
that referenced
this pull request
Apr 3, 2023
npepinpe
added
the
version:8.2.0
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 9, 2024
…r-plugin to v3.13.0 (#12205) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This removes two properties from our default properties because they are confusing and did not work as expected.
management.endpoint.<id>.enabledappears to only work for built-in actuators and not for our custom ones.This is not new and I suspect that this never worked as expected. For 8.1 we can see that the backup actuator was available even when it was supposed to be disabled by default:
Similar for the partitions endpoint on 1.3 which was supposed to be enabled by default but should be disabled when setting
MANAGEMENT_ENDPOINTS_PARTITIONS_ENABLED=false:Here we can see that this endpoint exists anyway.
I can't find any references to this but I suspect that the enable flags only work for built-in actuators. We can still control which actuators are available by configuring
MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDEwhich actually does work as expected.