hashicorp/consul

Allow more parameters in topology view `dashboard_url_templates.service`

Open

#12,401 opened on Feb 20, 2022

View on GitHub
 (6 comments) (2 reactions) (0 assignees)Go (4,588 forks)batch import
good first issuetheme/uitype/enhancement

Repository metrics

Stars
 (29,891 stars)
PR merge metrics
 (Avg merge 8d 12h) (41 merged PRs in 30d)

Description

Feature Description

Allow more parameters in ui_config.dashboard_url_templates.service. Parameters like {{Service.Meta.xxx}}.

This was actually allowed and worked back in version 1.9.x

Use Case(s)

Using Consul meta to provide links in topology visualization. For example, when registering service with:

meta {
        dashboard = "G7Z29GzMGz"
        alloc_id = NOMAD_ALLOC_ID
      }

and

  ui_config:
     dashboard_url_templates:
      service: !unsafe "https://grafana.service.consul/d/{{Service.Meta.dashboard}}"

resulting link in the UI should be https://grafana.service.consul/d/G7Z29GzMGz

Contributor guide

Research direction
Examine the code that processes `dashboard url templates.service` in Consul's UI configuration. Look for where template variables like `{{Service.Meta.xxx}}` are parsed and replaced, likely in the agent or UI backend. Investigate why this worked in version 1.9.x and what changed. Then, identify the necessary changes to re enable support for arbitrary `Service.Meta` keys in URL templates.
Tech stack
go
Domain
infrastructure
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50