Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions version/example_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright 2024 The Prometheus Authors

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Copyright 2024 The Prometheus Authors
// Copyright The Prometheus Authors

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package version_test

import (
"github.com/prometheus/common/promslog"
"github.com/prometheus/common/version"
)

// ExampleSlog mirrors the documented usage of version.Slog and keeps it
// compiling, so the example in the godoc cannot drift from the real API.
func ExampleSlog() {
logger := promslog.New(&promslog.Config{})
logger.Info("Starting Prometheus Server", version.Slog()...)
}
2 changes: 1 addition & 1 deletion version/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ func BuildContext() string {
// Slog returns a slice of strings for use with structured logging.
//
// Example:
// logger := promslog.New(promslog.Config{})
// logger := promslog.New(&promslog.Config{})
// logger.Info("Starting Prometheus Server", version.Slog()...)
func Slog() []any {
return []any{
Expand Down
Loading