Skip to content

Conversation

Copy link

Copilot AI commented Jan 23, 2026

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.

Co-authored-by: TimHess <3947063+TimHess@users.noreply.github.com>
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
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.

2 participants