3.8.2. UsageΒΆ

Note

Added in EHRbase version 0.15.0

By default all status and metric endpoints are disabled in EHRbase. To opt-in endpoints you should start the EHRbase with an environment variable per endpoint you want to enable.

Run from command line:

$~/ehrbase: export MANAGEMENT_ENDPOINT_ENV_ENABLE=true
$~/ehrbase: java -jar application/target/application-0.15.0.jar

Run from Docker container:

$~/: docker run -e MANAGEMENT_ENDPOINT_ENV_ENABLE=true --name ehrbase --network ehrbase-net -p 8080:8080 -d ehrbase/ehrbase:latest

The following table lists all available endpoints that can be enabled with environment variables:

Parameter Usage Example
MANAGEMENT_ENDPOINT_ENV_ENABLED Enable /management/env endpoint from actuator true / false
MANAGEMENT_ENDPOINT_HEALTH_ENABLED Enable /management/health endpoint from actuator true / false
MANAGEMENT_ENDPOINT_INFO_ENABLED Enable /management/info endpoint from actuator true / false
MANAGEMENT_ENDPOINT_METRICS_ENABLED Enable /management/metrics endpoint from actuator true / false
MANAGEMENT_ENDPOINT_PROMETHEUS_ENABLED Enable /management/prometheus endpoint from actuator true / false

Additionally you can configure the following actuator settings if required:

Parameter Usage Example    
MANAGEMENT_ENDPOINT_HEALTH_PROBES_ENABLE Enable Kubernetes probe endpoints /management/health/liveness and /management/health/readiness explicit in non Kubernetes environments true/false    
MANAGEMENT_ENDPOINTS_WEB_EXPOSUSE Expose enabled endpoint to clients. Only set if required env health info
MANAGEMENT_ENDPOINTS_WEB_BASEPATH Change base path for all endpoints /management