Actuator Info

Overview

Helix Spring Boot webservice that shows how service identity and metadata are exposed through the info actuator endpoint.

Run this example from the shared examples build:

./gradlew -p examples runExample -Pexample=rest-api/actuator-info --init-script "$(pwd)/helix.init.gradle"

What It Shows

• the Helix API starter baseline
• enabling the management info endpoint on a dedicated management port
• Helix-specific service details exposed under the helix section of the info payload
• custom metadata flowing from helix.metadata.* properties into the actuator response
• using the info endpoint for runtime audit and inventory checks

Endpoints

• GET /v1/actuator-info/summary
• GET /info
• GET /liveness
• GET /health

Example success response

{
  "request_id": "generated-by-helix",
  "status": "SUCCESS",
  "timestamp": "2026-03-15T12:34:56+0000",
  "data": {
    "application": "actuator-info",
    "infoEndpoint": "http://localhost:8081/info",
    "auditPurpose": "Review Helix service identity, version, and metadata through the management info endpoint."
  }
}

Example actuator response

{
  "helix": {
    "app_id": "actuator-info",
    "environment": "default",
    "organization": "helix",
    "start_time": "2026-03-15T20:30:42.635Z",
    "uptime": "0 Days 0 Hours 0 Minutes 13 Seconds",
    "helix_version": "0.3.0-SNAPSHOT",
    "metadata": {
      "owner": "platform",
      "service_tier": "gold"
    }
  }
}

Development

Building the Application

Run the following command to build the service:

./gradlew clean build

Testing the Application

Run the following command to run the service tests:

./gradlew test
./gradlew integration

Trying the API

Run the service:

Then try:

The business endpoint explains the audit flow, and the management endpoint returns Helix-specific service details such as app_id, app_version, organization, environment, instance_id, helix_version, and any configured helix.metadata.* entries.

./gradlew bootRun

curl http://localhost:8080/v1/actuator-info/summary

curl http://localhost:8081/info