diff --git a/website/content/docs/connect/observability/ui-visualization.mdx b/website/content/docs/connect/observability/ui-visualization.mdx index 2c66527bc7..9e4f5ef4c3 100644 --- a/website/content/docs/connect/observability/ui-visualization.mdx +++ b/website/content/docs/connect/observability/ui-visualization.mdx @@ -33,6 +33,7 @@ be supported using a new and experimental JavaScript API. See [Custom Metrics Providers](#custom-metrics-providers). ## Kubernetes + If running Consul in Kubernetes, the Helm chart can automatically configure Consul's UI to display topology visualizations. See our [Kubernetes observability docs](/docs/k8s/connect/observability/metrics) for more information. @@ -92,6 +93,9 @@ to the relevant information. An example with Grafana is shown below. + + + ```hcl ui_config { enabled = true @@ -107,6 +111,32 @@ ui_config { without horizontal scrolling in the example above however this needs to be a normal single-line string value in an HCL configuration file. + + + +On Kubernetes, Consul Server configuration is set in your Helm config via the +[`server.extraConfig`](/docs/k8s/helm#v-server-extraconfig) key as JSON: + +```yaml +# The UI is enabled by default so this stanza is not required. +ui: + enabled: true +server: + extraConfig: | + { + "ui_config": { + "dashboard_url_templates": { + "service": "https://grafana.example.com/d/lDlaj-NGz/service-overview?orgId=1&var-service={{ "{{" }}Service.Name}}&var-namespace={{ "{{" }}Service.Namespace}}&var-dc={{ "{{" }}Datacenter}}" + } + } + } +``` + +-> **Note**: The `{{` characters in the URL must be escaped using `{{ "{{" }}` so that Helm doesn't try to template them. + + + + ![Consul UI Service Dashboard Link](/img/ui-dashboard-url-template.png) ### Metrics Proxy