Include metric name in exception message

vlahanas · vlahanas · commit aa31cc07c499 · 2023-10-11T15:54:36.000+03:00
Add metric name in the runtime exception message which is thrown when escapeAllLabels fails to combine labels.

Signed-off-by: vlahanas &lt;v.lahanas@ferryhopper.com&gt;
diff --git a/src/Prometheus/RenderTextFormat.php b/src/Prometheus/RenderTextFormat.php
@@ -40,7 +40,7 @@ private function renderSample(MetricFamilySamples $metric, Sample $sample): stri
     {
         $labelNames = $metric->getLabelNames();
         if ($metric->hasLabelNames() || $sample->hasLabelNames()) {
-            $escapedLabels = $this->escapeAllLabels($labelNames, $sample);
+            $escapedLabels = $this->escapeAllLabels($metric, $labelNames, $sample);
             return $sample->getName() . '{' . implode(',', $escapedLabels) . '} ' . $sample->getValue();
         }
         return $sample->getName() . ' ' . $sample->getValue();
@@ -56,19 +56,20 @@ private function escapeLabelValue(string $v): string
     }
 
     /**
+     * @param MetricFamilySamples $metric
      * @param string[] $labelNames
      * @param Sample $sample
      *
      * @return string[]
      */
-    private function escapeAllLabels(array $labelNames, Sample $sample): array
+    private function escapeAllLabels(MetricFamilySamples $metric, array $labelNames, Sample $sample): array
     {
         $escapedLabels = [];
 
         $labels = array_combine(array_merge($labelNames, $sample->getLabelNames()), $sample->getLabelValues());
 
         if ($labels === false) {
-            throw new RuntimeException('Unable to combine labels.');
+            throw new RuntimeException('Unable to combine labels for metric named ' . $metric->getName());
         }
 
         foreach ($labels as $labelName => $labelValue) {

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ private function renderSample(MetricFamilySamples $metric, Sample $sample): stri`
`40`	`40`	`{`
`41`	`41`	`$labelNames = $metric->getLabelNames();`
`42`	`42`	`if ($metric->hasLabelNames() \|\| $sample->hasLabelNames()) {`
`43`		`- $escapedLabels = $this->escapeAllLabels($labelNames, $sample);`
	`43`	`+ $escapedLabels = $this->escapeAllLabels($metric, $labelNames, $sample);`
`44`	`44`	`return $sample->getName() . '{' . implode(',', $escapedLabels) . '} ' . $sample->getValue();`
`45`	`45`	`}`
`46`	`46`	`return $sample->getName() . ' ' . $sample->getValue();`
`@@ -56,19 +56,20 @@ private function escapeLabelValue(string $v): string`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`/**`
	`59`	`+ * @param MetricFamilySamples $metric`
`59`	`60`	`* @param string[] $labelNames`
`60`	`61`	`* @param Sample $sample`
`61`	`62`	`*`
`62`	`63`	`* @return string[]`
`63`	`64`	`*/`
`64`		`- private function escapeAllLabels(array $labelNames, Sample $sample): array`
	`65`	`+ private function escapeAllLabels(MetricFamilySamples $metric, array $labelNames, Sample $sample): array`
`65`	`66`	`{`
`66`	`67`	`$escapedLabels = [];`
`67`	`68`
`68`	`69`	`$labels = array_combine(array_merge($labelNames, $sample->getLabelNames()), $sample->getLabelValues());`
`69`	`70`
`70`	`71`	`if ($labels === false) {`
`71`		`- throw new RuntimeException('Unable to combine labels.');`
	`72`	`+ throw new RuntimeException('Unable to combine labels for metric named ' . $metric->getName());`
`72`	`73`	`}`
`73`	`74`
`74`	`75`	`foreach ($labels as $labelName => $labelValue) {`