Skip to content
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

Jump to bottom

Document sidecar health indicators #1224

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Document sidecar health indicators #1224

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd77e98
Document sidecar health indicators
vmikhailenko Sep 2, 2024
94dbe1b
Leave only one health indicator
vmikhailenko Sep 5, 2024
d6f7cc4
Fix
vmikhailenko Sep 5, 2024
d2dfa06
Fix
vmikhailenko Sep 5, 2024
4501e3d
Merge branch 'main' into java-sidecar-health-indicators
vmikhailenko Sep 5, 2024
98cf493
Update observability.md
beckermarc Sep 5, 2024
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
12 changes: 11 additions & 1 deletion java/operating-applications/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Configure your application to enable the Open Telemetry Java Agent by adding or

The buildpack delivers the Open Telemetry Agent Extension library with the common configuration for Open Telemetry that applies to Cloud Logging Service and Dynatrace. This library provides out-of-the box configuration of the required credentials taken from the service bindings and more sophisticated configuration possibilities.

[Learn more in the Open Telemetry Agent Extension library documentation](https://github.com/SAP/cf-java-logging-support/tree/main/cf-java-logging-support-opentelemetry-agent-extension){.learn-more}
[Learn more in the Open Telemetry Agent Extension library documentation](https://github.com/SAP/cf-java-logging-support/tree/main/cf-java-logging-support-opentelemetry-agent-extension){.learn-more}

For troubleshooting purposes, you can increase the log level of the Open Telemetry Java Agent by adding the parameter `-Dotel.javaagent.debug=true` to the `JBP_CONFIG_JAVA_OPTS` argument.

Expand Down Expand Up @@ -594,6 +594,16 @@ The example configuration makes Spring exposing only the health endpoint with he
For multitenancy scenarios, CAP Java SDK replaces default the `db` indicator with an implementation that includes the status of all tenant databases.
:::

CAP offers two additional health indicators for MTX sidecars:
- `modelProvider` for the sidecar backing [Model Provider Service](/java/reflection-api#the-model-provider-service)
- `deploymentService` for the sidecar backing [Multitenancy](/java/multitenancy#multitenancy)

You can use them independently, but if both services use the same sidecar, health endpoint of the sidecar will receive calls from each health check independently. In this case, you can choose one of the indicators that best suit your application.

::: warning
These health indicators require sidecar to use `@sap/cds` version 7.8.0 or higher.
:::

Endpoint `/actuator/health` delivers a response (HTTP response code `200` for up, `503` for down) in JSON format with the overall `status` property (for example, `UP` or `DOWN`) and the contributing components:

```json
Expand Down