Skip to content

Document RuntimeInfoContributor in v4 Info actuator endpoint#415

Merged
TimHess merged 4 commits into
mainfrom
copilot/update-v4-info-endpoint-docs
Jan 30, 2026
Merged

Document RuntimeInfoContributor in v4 Info actuator endpoint#415
TimHess merged 4 commits into
mainfrom
copilot/update-v4-info-endpoint-docs

Conversation

Copilot AI commented Jan 23, 2026

Copy link
Copy Markdown
Contributor

Documents the new RuntimeInfoContributor added in Steeltoe 4.1.0 that exposes runtime environment information.

Changes

  • Added "Runtime info" section under Built-in Contributors documenting the 7 exposed properties:

    • runtimeName - .NET runtime name and version
    • runtimeVersion - CLR version
    • runtimeIdentifier - Platform RID (e.g., "linux-x64")
    • processArchitecture - Process architecture (e.g., "X64", "Arm64")
    • osArchitecture - OS architecture
    • osDescription - OS description
    • osVersion - OS version
  • Updated Sample Output to include the runtime section:

{
  "runtime": {
    "runtimeName": ".NET 10.0.0",
    "runtimeVersion": "10.0.0",
    "runtimeIdentifier": "linux-x64",
    "processArchitecture": "X64",
    "osArchitecture": "X64",
    "osDescription": "Ubuntu 22.04.3 LTS",
    "osVersion": "Unix 5.15.0.88"
  }
}
Original prompt

Summary

Update the v4 documentation for the Info actuator endpoint to document the new RuntimeInfoContributor being added in SteeltoeOSS/Steeltoe#1640.

Changes Required

Update the file docs/docs/v4/management/info.md with the following content:

# Info

The Steeltoe Info endpoint exposes information about the running application, such as its version and the version of Steeltoe in use.

Information is collected from all `IInfoContributor` implementations registered in the application. 
Steeltoe includes a couple of contributor implementations out of the box that you can use. 
You can also write your own implementations. 

## Configure Settings

The following table describes the configuration settings that you can apply to the endpoint. 
Each key must be prefixed with `Management:Endpoints:Info:`.

| Key | Description | Default |
| --- | --- | --- |
| `Enabled` | Whether the endpoint is enabled | `true` |
| `ID` | The unique ID of the endpoint | `info` |
| `Path` | The relative path at which the endpoint is exposed | same as `ID` |
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry | `Restricted` |
| `AllowedVerbs` | An array of HTTP verbs at which the endpoint is exposed | `GET` |

## Enable HTTP Access

The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section. 
The default path is `/actuator/info`.

See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.

To add the actuator to the service container and map its route, use the `AddInfoActuator` extension method. 

Add the following code to `Program.cs` to use the actuator endpoint:

```csharp
using Steeltoe.Management.Endpoint.Actuators.Info;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddInfoActuator();
```

> [!TIP]
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators;
> this enables individually turning them on/off at runtime via configuration.

## Built-in Contributors

### Build info

This contributor exposes file/version info for both the application and the included version of Steeltoe. 

### Configuration

This contributor exposes any values below the `Info` configuration key.  For example:

```json
{
  "Info": {
    "Some": {
      "Example": {
        "Key": "some-example-value"
      }
    }
  }
}
```

> [!TIP]
> When combined with the [Placeholder Configuration Provider](../configuration/placeholder-provider.md),
> compound configuration values can be exposed originating from other places in configuration.

### Git properties

This contributor exposes information from the `git.properties` Spring Boot file, if available.  The file contains information from git, such as branch/tag name, commit hash, and remote. 

> [!TIP]
> For an example of how to use this contributor within MSBuild using [GitInfo](https://github.com/devlooped/GitInfo), see the [Steeltoe Management sample](https://github.com/SteeltoeOSS/Samples/tree/4.x/Management/src).

### Runtime info

This contributor, added in Steeltoe 4.1.0, exposes information about the environment in which the application is running. It includes:

| Property | Description |
| --- | --- |
| `runtimeName` | The name and version of the .NET runtime (for example, ".NET 10.0.0") |
| `runtimeVersion` | The version of the common language runtime |
| `runtimeIdentifier` | The runtime identifier (RID) of the platform (for example, "linux-x64", "win-x64") |
| `processArchitecture` | The process architecture (for example, "X64", "Arm64") |
| `osArchitecture` | The operating system architecture |
| `osDescription` | A description of the operating system |
| `osVersion` | The operating system version |

## Sample Output

The response is always returned as JSON: 

```json
{
  "git": {
    "branch": "main",
    "build": {
      "host": "examplehost",
      "time": "2024-10-11T18:44:28.9255701Z",
      "user": {
        "email": "user@email.com",
        "name": "testuser"
      },
      "version": "2.1.0"
    },
    "commit": {
      "id": "90d0870a363fafcb50981b7038608b763e527e05",
      "time": "2024-10-08T17:30:57Z"
    },
    "remote": {
      "origin": {
        "url": "https://github.com/SteeltoeOSS/Samples"
      }
    },
    "tags": "2.1.0-644-g90d0870a"
  },
  "Some": {
    "Example": {
      "Key": "some-example-value"
    }
  },
  "applicationVersionInfo": {
    "ProductName": "ExampleApp",
    "FileVersion": "1.0.0.0",
    "ProductVersion": "1.0.0+df774c38b734857909d54b796fffbb717eced4a4"
  },
  "steeltoeVersionInfo": {
    "ProductName": "Steeltoe.Management.Endpoint",
    "FileVersion": "4.0.519.27703",
    "ProductVersion": "4.0.519-alpha+6c377e2ac3"
 ...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs.

Copilot AI changed the title [WIP] Update v4 documentation for Info actuator endpoint Document RuntimeInfoContributor in v4 Info actuator endpoint Jan 23, 2026
Copilot AI requested a review from TimHess January 23, 2026 21:40
Comment thread .github/workflows/build-and-stage.yml Outdated
Comment thread .github/workflows/build-and-stage.yml
@bart-vmware bart-vmware changed the base branch from main to docfx-workaround January 30, 2026 10:57
@bart-vmware bart-vmware force-pushed the copilot/update-v4-info-endpoint-docs branch from 6c035b7 to 34eb416 Compare January 30, 2026 11:03
bart-vmware
bart-vmware previously approved these changes Jan 30, 2026
@github-actions

Copy link
Copy Markdown

Preview link: https://www-steeltoe-pr-415.azurewebsites.net

  • Your changes have been deployed to the preview site. The preview site will update as you add more commits to this branch.
  • The preview link is shareable, but will be deleted when the pull request is merged or closed.

This is an automated message.

Base automatically changed from docfx-workaround to main January 30, 2026 14:58
@bart-vmware bart-vmware dismissed their stale review January 30, 2026 14:58

The base branch was changed.

@TimHess TimHess force-pushed the copilot/update-v4-info-endpoint-docs branch from 34eb416 to 6d18f3e Compare January 30, 2026 14:59
@TimHess TimHess marked this pull request as ready for review January 30, 2026 15:00
Copilot AI review requested due to automatic review settings January 30, 2026 15:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the v4 Info actuator documentation to cover the new RuntimeInfoContributor in Steeltoe 4.1.0 and adjusts the build-and-stage GitHub Actions workflow.

Changes:

  • Adds a “Runtime info” built-in contributor section documenting the runtime-related properties exposed by the RuntimeInfoContributor.
  • Extends the Info endpoint sample JSON output to include the new runtime section with the documented properties.
  • Updates the build-and-stage workflow to newer major versions of core GitHub Actions and expands the set of installed .NET SDK versions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/docs/v4/management/info.md Documents the RuntimeInfoContributor and its properties and updates the sample Info actuator JSON to include a runtime object.
.github/workflows/build-and-stage.yml Bumps actions/checkout, actions/setup-dotnet, and actions/upload-artifact versions and configures the workflow to install .NET SDKs 8.0, 9.0, and 10.0.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TimHess TimHess merged commit a8e401a into main Jan 30, 2026
9 checks passed
@TimHess TimHess deleted the copilot/update-v4-info-endpoint-docs branch January 30, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants