Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
healthcheck-mechanism.adoc: escape example of URL that is not browsable
Browse files Browse the repository at this point in the history
tbouffard committed Jan 9, 2025

Verified

This commit was signed with the committer’s verified signature.
tbouffard Thomas Bouffard
1 parent ac58d87 commit 265b1d6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions modules/runtime/pages/healthcheck-mechanism.adoc
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@

[#api-health-endpoints]
== API health endpoints
The Bonita docker image provides one API endpoint, /healthz to indicate the current state of the platform (accessed by the URL https://<serverURL>/bonita/healthz).
The Bonita docker image provides one API endpoint, `/healthz` to indicate the current state of the platform (accessed by the URL `+https://<serverURL>/bonita/healthz+`).
A call to the URL will typically return the following information in JSON format:

[source,json]
@@ -19,11 +19,11 @@ A call to the URL will typically return the following information in JSON format
"executionTimeMillis":"7"}
----

The most common "unhealthy" state will be that the /healthz URL is not accessible.
The most common "unhealthy" state will be that the `/healthz` URL is not accessible.

== Security

The /healthz endpoint is protected by a username/password authentication. The default values are username `monitoring` and password `mon1tor1ng_adm1n`.
The `/healthz` endpoint is protected by a username/password authentication. The default values are username `monitoring` and password `mon1tor1ng_adm1n`.
It is very much recommended to change those values. It can be done by overriding the following environment properties:

[source,text]
@@ -47,5 +47,5 @@ docker run -p 8080:8080 -v ~/lic:/opt/bonita_lic/ --env-file ~/bonita.env --name
----

== Internal Workings
The /healthz endpoint is an internal class that retrieves various information through the PlatformAPI.java.
If one of the requested information cannot be retrieved (ie. if the API call raises an exception), the endpoint will return a status "error" with a stacktrace.
The `/healthz` endpoint is an internal class that retrieves various information through the PlatformAPI.java.
If one of the requested information cannot be retrieved (i.e. if the API call raises an exception), the endpoint will return a status "error" with a stacktrace.

0 comments on commit 265b1d6

Please sign in to comment.