upstream/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2026-05-28 04:02:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Properly generate classic/histogram and summary metrics

Browse source 
Signed-off-by: Arthur Silva Sens <arthursens2005@gmail.com>
This commit is contained in:
Arthur Silva Sens 2026-01-16 11:18:11 -03:00
parent 152556d414
commit d79fc2655a
No known key found for this signature in database
2 changed files with 119 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
build/semconv/templates/go/helpers.j2
View file

@ -102,3 +102,22 @@ It {{ brief }}.
{%- if member.value is int %}int64{%- endif %}
{%- if member.value is float %}float64{%- endif %}
{%- endmacro %}
{#- Macro to convert duration string to Go code (e.g., "1h" -> "1 * time.Hour") -#}
{%- macro duration_to_go(dur_str) -%}
{%- if dur_str is string -%}
{%- if dur_str.endswith("h") -%}
{{ dur_str[:-1] }} * time.Hour
{%- elif dur_str.endswith("m") -%}
{{ dur_str[:-1] }} * time.Minute
{%- elif dur_str.endswith("s") -%}
{{ dur_str[:-1] }} * time.Second
{%- elif dur_str.endswith("ms") -%}
{{ dur_str[:-2] }} * time.Millisecond
{%- else -%}
{{ dur_str }}
{%- endif -%}
{%- else -%}
{{ dur_str }}
{%- endif -%}
{%- endmacro -%}

105
build/semconv/templates/go/metrics.go.j2
View file

@ -3,6 +3,15 @@
{%- set all_metrics = ctx | map(attribute="metrics") | flatten | list -%}
{# Extract all unique attributes from all metrics #}
{%- set all_attrs = all_metrics | selectattr("attributes") | map(attribute="attributes") | flatten | unique(attribute="name") | sort(attribute="name") -%}
{# Check if we need time import - look for native/mixed histograms #}
{%- set ns = namespace(needs_time=false) -%}
{%- for metric in all_metrics -%}
{%- if metric.annotations is defined and metric.annotations.prometheus is defined -%}
{%- if metric.annotations.prometheus.histogram_type in ["native_histogram", "mixed_histogram"] -%}
{%- set ns.needs_time = true -%}
{%- endif -%}
{%- endif -%}
{%- endfor -%}
// Code generated from semantic convention specification. DO NOT EDIT.
// Package metrics provides Prometheus instrumentation types for metrics
@ -12,7 +21,10 @@ package metrics
import (
{%- if all_attrs | selectattr("type","!=","string") | list | length > 0 %}
"fmt"
{%- endif %}
{% endif %}
{%- if ns.needs_time %}
"time"
{% endif %}
"github.com/prometheus/client_golang/prometheus"
)
@ -81,9 +93,15 @@ func (a {{ name }}Attr) Value() string {
{% endmacro %}
{%- for metric in all_metrics %}
{%- set metric_name = h.to_go_name(metric.metric_name, "") %}
{%- set metric_inst = (metric.instrument | default("gauge")) | map_text("go_instrument_type") %}
{%- set metric_attr = metric.attributes | default([]) | sort -%}
{%- set has_labels = (metric_attr | length) > 0 -%}
{%- set prom = (metric.annotations | default({})).prometheus | default({}) -%}
{#- Determine the actual Prometheus type based on instrument and histogram_type -#}
{%- if metric.instrument == "histogram" and prom.histogram_type == "summary" -%}
{%- set metric_inst = "Summary" -%}
{%- else -%}
{%- set metric_inst = (metric.instrument | default("gauge")) | map_text("go_instrument_type") -%}
{%- endif -%}
{{ h.metric_typedoc(metric, "") | comment | trim }}
type {{ metric_name }} struct {
@ -102,18 +120,95 @@ func New{{ metric_name }}() {{ metric_name }} {
"{{ attr.id }}",
{%- endcall %}
}
{%- endif %}
{%- if metric.instrument == "histogram" and prom.histogram_type %}
{%- if prom.histogram_type == "summary" %}
return {{ metric_name }}{
{%- if has_labels %}
SummaryVec: prometheus.NewSummaryVec(prometheus.SummaryOpts{
{%- else %}
Summary: prometheus.NewSummary(prometheus.SummaryOpts{
{%- endif %}
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
Objectives: map[float64]float64{
{%- for quantile, error in prom.objectives.items() %}
{{ quantile }}: {{ error }},
{%- endfor %}
},
{%- if has_labels %}
}, labels),
{%- else %}
}),
{%- endif %}
}
{%- elif prom.histogram_type == "classic_histogram" %}
return {{ metric_name }}{
{%- if has_labels %}
HistogramVec: prometheus.NewHistogramVec(prometheus.HistogramOpts{
{%- else %}
Histogram: prometheus.NewHistogram(prometheus.HistogramOpts{
{%- endif %}
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
Buckets: []float64{ {{- prom.buckets | join(", ") -}} },
{%- if has_labels %}
}, labels),
{%- else %}
}),
{%- endif %}
}
{%- elif prom.histogram_type == "native_histogram" %}
return {{ metric_name }}{
{%- if has_labels %}
HistogramVec: prometheus.NewHistogramVec(prometheus.HistogramOpts{
{%- else %}
Histogram: prometheus.NewHistogram(prometheus.HistogramOpts{
{%- endif %}
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
NativeHistogramBucketFactor: {{ prom.bucket_factor }},
NativeHistogramMaxBucketNumber: {{ prom.max_bucket_number }},
NativeHistogramMinResetDuration: {{ h.duration_to_go(prom.min_reset_duration) }},
{%- if has_labels %}
}, labels),
{%- else %}
}),
{%- endif %}
}
{%- elif prom.histogram_type == "mixed_histogram" %}
return {{ metric_name }}{
{%- if has_labels %}
HistogramVec: prometheus.NewHistogramVec(prometheus.HistogramOpts{
{%- else %}
Histogram: prometheus.NewHistogram(prometheus.HistogramOpts{
{%- endif %}
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
Buckets: []float64{ {{- prom.buckets | join(", ") -}} },
NativeHistogramBucketFactor: {{ prom.bucket_factor }},
NativeHistogramMaxBucketNumber: {{ prom.max_bucket_number }},
NativeHistogramMinResetDuration: {{ h.duration_to_go(prom.min_reset_duration) }},
{%- if has_labels %}
}, labels),
{%- else %}
}),
{%- endif %}
}
{%- endif %}
{%- else %}
return {{ metric_name }}{
{%- if has_labels %}
{{ metric_inst }}Vec: prometheus.New{{ metric_inst }}Vec(prometheus.{{ metric_inst }}Opts{
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
}, labels),
}
{%- else %}
return {{ metric_name }}{
{{ metric_inst }}: prometheus.New{{ metric_inst }}(prometheus.{{ metric_inst }}Opts{
Name: "{{ metric.metric_name }}",
Help: "{{ metric.brief | default("") | trim }}",
}),
{%- endif %}
}
{%- endif %}
}
@ -132,7 +227,7 @@ func (m {{ metric_name }}) With(
{{ attr.arg }} {{ attr.type }},
{%- endcall %}
extra ...{{ metric_name }}Attr,
) prometheus.{{ metric_inst | replace("Histogram", "Observer") }} {
) prometheus.{{ metric_inst | replace("Histogram", "Observer") | replace("Summary", "Observer") }} {
labels := prometheus.Labels{
{%- call(attr) for_each_attr(metric_attr|required) %}
"{{ attr.id }}": {{ attr.arg }}.Value(),