Create liveliness endpoint by asalan316 · Pull Request #1506 · cloudfoundry/app-autoscaler-release

asalan316 · 2023-03-02T11:30:44Z

This change introduces new /health/liveness endpoint, allowing users to check the health of the individual services
The response

{"overall_status":"UP","checks":[]}

Also, the following existing endpoints are now moved to the new paths

Golang Microservices

Exisiting Routes	New Health Routes
/	/health/prometheus
/debug/pprof	/health/debug/pprof
/debug/pprof	/health/debug/pprof
-	/health/liveness (new)
-	/health (respond to /health/liveness )

Scheduler Microservice

Exisiting Routes	New Health Routes
/health	/health/prometheus
/prometheus	/health/prometheus
-	/health/liveness (new)
-	/health (respond to /health/liveness )

By default, all health routes are protected with basic auth.

However, routes can be configured to be unprotected by using the configuration
autoscaler.apiserver.health.unprotected_endpoints

Fix test;

Changes to get 'make test' running Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> commenting out 3 of 4/5 Collect statements for debugging Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> commenting out 4 of 4/5 Collect statements for debugging Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding print statements and commenting out 3 of 4/5 Collect statements for debugging Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding more print statements Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding more print statements Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding more print statements Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding more print statements Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> adding more debug print statements Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Revert "adding more debug print statements" This reverts commit eefc74f. Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Revert "adding more print statements" This reverts commit 958fd00. Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Revert "adding more print statements" This reverts commit 0b2d81b. Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Revert "adding more print statements" This reverts commit a25e782. Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Revert "adding more print statements" This reverts commit d433ce5. Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com> Adding print statements of status collect middleware to stderr Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com>

Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com>

Update spec/jobs/golangapiserver/apiserver_spec.rb Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> revert refactoring debug-> remove rate limiter atm to identify policy enpoints Revert "debug-> remove rate limiter atm to identify policy enpoints" This reverts commit f5e5c57. add test to verify health configurations enable default /actuator/health &a /actuator/promethus use standalone prometheus server for health endpoints Revert "enable default /actuator/health &a /actuator/promethus" This reverts commit 86e5523.

…metheus lib) wip:spring security wip: block health route to main server (port 8080) via spring security wip: Block health routes to main server (port 8080) using Request Filter wip: add basic auth for protected resource using servlet filter test health server configuration Adding MultiPortFilter tests finish MultiPortFilter tests

refactor: Basic and Port Filters fix java formatting issues

start health server on defined ports (Port 0 is not allowed)

…alth/liveness) to avoid breaking changes

joergdw · 2023-05-25T14:27:11Z

+    if (ObjectUtils.isEmpty(unprotectedEndpointsConfig)) { // health endpoints are authorized
+      isUserAuthenticatedOrSendError(chain, httpRequest, httpResponse);
+    } else if (!ObjectUtils.isEmpty(unprotectedEndpointsConfig)) {
+      Map<String, Boolean> validateMap = checkValidEndpoints(unprotectedEndpointsConfig);


I think a config-check should rather go into the config-class itself (see former comments).

The name may be misleading. I rather understand it as a nonExistingEndpoints.

Why do we need a boolean? Isn't pure existence enough? Then a set (as mentioned above) would be more appropriate.

As an additional note, when I think about what we want to do: It would simplify a lot to have a function with the following signature in the class HealthServerConfiguration:

public boolean endpointIsUnprotected(<Some type> endpoint) {…

It is then reusable here! And as it will be quite performant, this simplification would then make as well obvious that we do not need the special case treatment in the lines 58-59 of the current implementation.

…ler/rest/BasicAuthenticationFilter.java Co-authored-by: joergdw <joerg.weisbarth@sap.com>

…ler/conf/HealthServerConfiguration.java Co-authored-by: joergdw <joerg.weisbarth@sap.com>

sonarqubecloud · 2023-06-15T15:29:02Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

asalan316 force-pushed the create-liveliness-endpoint branch 2 times, most recently from 04bc7db to 445429d Compare March 8, 2023 15:21

joergdw added the 🚧🛠️ WIP📝 Work in progress label Mar 8, 2023

joergdw requested a review from a team March 9, 2023 13:42

joergdw force-pushed the create-liveliness-endpoint branch from fda104a to 472375b Compare March 13, 2023 09:56

asalan316 force-pushed the create-liveliness-endpoint branch from 478b82a to be9db41 Compare March 13, 2023 16:31

joergdw force-pushed the create-liveliness-endpoint branch from be9db41 to 44d0f76 Compare March 14, 2023 09:08

joergdw added the allow-acceptance-tests This label needs to be added to enable the acceptance tests to run. label Mar 14, 2023

joergdw force-pushed the create-liveliness-endpoint branch 12 times, most recently from d8fabe2 to d484f7b Compare March 14, 2023 14:29

joergdw removed the 🚧🛠️ WIP📝 Work in progress label Mar 14, 2023

joergdw force-pushed the create-liveliness-endpoint branch 5 times, most recently from de0e65d to 8498b9b Compare March 17, 2023 15:28

asalan316 force-pushed the create-liveliness-endpoint branch 4 times, most recently from 0270ec1 to 2865f60 Compare March 28, 2023 14:58

joergdw and others added 11 commits May 11, 2023 17:20

Fix test-configuration for apiserver

fdb2517

Fix test;

refactoring of API Routes

88c62c0

Co-authored-by: Susanne Salzmann <susanne.salzmann@sap.com>

golangapiserver-> exposee health server port via route registrar

b4ab911

scheduler-> MultiPortFilter to differntiate health and main requests

16becb0

refactor: Basic and Port Filters fix java formatting issues

metricsforwarder-> Bosh Template Specs

d3892e6

metricsgateway-> Bosh Template Specs

f9f2b22

metricsserver-> Bosh Template Specs

2e0fa57

operator-> Bosh Template Specs

a7ba83b

github-actions Bot reviewed May 12, 2023

View reviewed changes

Comment thread style-guide/google-format-ci-v0.1.sh

scalingengine-> Bosh Template Specs

d246a4d

joergdw requested changes May 17, 2023

View reviewed changes

asalan316 added 2 commits May 22, 2023 15:01

Review-> Remove Health routes from broker server & public Api server

b6818eb

Review-> Scehduler ->add java commons-codec for Base64 operations

d3a5531

joergdw requested changes May 23, 2023

View reviewed changes

asalan316 added 3 commits May 23, 2023 16:42

Review-> Docs -> add SVG for the scheduler API Docs

dc2876b

Review -> Scheduler -> validate health port

f09bc70

start health server on defined ports (Port 0 is not allowed)

liveness information should also be available at /health (besides /he…

f853498

…alth/liveness) to avoid breaking changes

joergdw requested changes May 25, 2023

View reviewed changes

asalan316 and others added 8 commits May 25, 2023 17:38

Update src/scheduler/src/main/java/org/cloudfoundry/autoscaler/schedu…

9688bf5

…ler/rest/BasicAuthenticationFilter.java Co-authored-by: joergdw <joerg.weisbarth@sap.com>

Update src/scheduler/src/main/java/org/cloudfoundry/autoscaler/schedu…

1906dd9

…ler/conf/HealthServerConfiguration.java Co-authored-by: joergdw <joerg.weisbarth@sap.com>

Update src/scheduler/src/main/java/org/cloudfoundry/autoscaler/schedu…

6c3ffef

…ler/conf/HealthServerConfiguration.java Co-authored-by: joergdw <joerg.weisbarth@sap.com>

change unprotected type to Set (instead of List)

4abcaad

Refactor BasicAuthenticationFilter

87416bc

change valid endpoints to Enum types

145d426

Merge branch 'main' into create-liveliness-endpoint

3aeb2ae

add missing java files

0a8b9db

Conversation

asalan316 commented Mar 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joergdw May 25, 2023

Choose a reason for hiding this comment

Uh oh!

joergdw May 25, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jun 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

asalan316 commented Mar 2, 2023 •

edited

Loading