spring-cloud / spring-cloud/spring-cloud-config

Make config version available on client at runtime

Open
#1,007 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
2k
Forks
1.3k
Avg merge
2d 59m
Merged PRs (30d)
16

Description

This is a feature request. The response from the config server when a client requests its config contains a version. It would be nice if this version were available at runtime on the client so you can check what specific version of config is being used by a client at a given time. While the label is known on the client, it could be a git branch which points to different commits at different times.

A couple off the cuff ideas:
An InfoContributor that adds this information to the /info Actuator endpoint. Another idea is incorporating this version into the /env Actuator endpoint, perhaps most simply by naming the property sources with the version. It might be nice to somehow separately know the environment repositories contributing to the environment and their version, considering there may be more than one (tangentially related: the version is always null in the config server response when using the composite env repo).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the config client receives the config server response and how the /info and /env Actuator endpoints expose runtime data. Compare the proposed InfoContributor and property-source naming approaches, including composite environment repositories. Done means the config version or contributing repository versions are available on the client at runtime.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
backend, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.