Skip to content

docs(expfmt): update OpenMetrics 2.0 supported metric types comments #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dashpole wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs(expfmt): update OpenMetrics 2.0 supported metric types comments #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions expfmt/expfmt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ func NewFormat(t FormatType) Format {
// NewOpenMetricsFormat generates a new OpenMetrics format matching the
// specified version number.
//
// Note: OpenMetrics version 2.0.0 is experimental and encode-only (currently
// supporting counter, gauge, and untyped metric types).
// Note: OpenMetrics version 2.0.0 is experimental and encode-only (supporting
// counter, gauge, summary, untyped, histogram, and gaugehistogram metric types).
func NewOpenMetricsFormat(version string) (Format, error) {
if version == OpenMetricsVersion_0_0_1 {
return FmtOpenMetrics_0_0_1, nil
Expand All @@ -122,7 +122,7 @@ func NewOpenMetricsFormat(version string) (Format, error) {
return FmtOpenMetrics_1_0_0, nil
}
if version == OpenMetricsVersion_2_0_0 {
// OpenMetrics 2.0.0 is experimental and encode-only (counter/gauge/untyped).
// OpenMetrics 2.0.0 is experimental and encode-only.
return fmtOpenMetrics_2_0_0, nil
}
return FmtUnknown, errors.New("unknown open metrics version string")
Expand Down
6 changes: 3 additions & 3 deletions expfmt/openmetrics_2_0_create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ import (
// It returns the number of bytes written and any error encountered.
//
// NOTE: This method targets OpenMetrics 2.0.0 (currently aligned with 2.0-rc.0) which is experimental and
// encode-only (currently supporting counter, gauge, summary, untyped, histogram, and gaugehistogram metric types).
// Breaking changes might happen in the future. This implementation is still a
// work-in-progress, and does not yet support all features of the format.
// encode-only. All metric types defined in client_model (counter, gauge, summary, untyped, histogram,
// and gaugehistogram) are supported; info and stateset are not supported as they are not present in
// client_model. Breaking changes might happen in the future.
// EncoderOptions are accepted for signature compatibility with
// MetricFamilyToOpenMetrics and are currently ignored.
//
Expand Down
Loading