mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
7674eebf56
* Removed different types of Detectors for Resources. This change simplifies different types of collectors into one list. The order of this list determines how they are applied. Defaults are applied when the user does not supply any detectors. To achieve default behavior and additional behavior a DefaultDetectors struct has been created * missed prometheus test. * Changed behavior around WithDetectors(nil) Added examples of use of WithDetectors. * Added NoOp example * Changed test to reflect acutal default case This changes because WithDetector() no longer is the same as not using WithDetector() * Unexports the noOp detector * Updated changelog * Fixes to spelling mistakes. * Added NewEmptyResouce and unexported builtin detectors * Fix for prometheus example * Resource has two Rs I need to get a new R key it seems. Co-authored-by: Sam Xie <xsambundy@gmail.com> * Replaced NewEmptyResource() with New() * Fix test function name * Comment fixups. * Apply suggestions from code review Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> Co-authored-by: Sam Xie <xsambundy@gmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
115 lines
3.0 KiB
Go
115 lines
3.0 KiB
Go
// Copyright The OpenTelemetry 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 prometheus_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/exporters/metric/prometheus"
|
|
"go.opentelemetry.io/otel/metric"
|
|
controller "go.opentelemetry.io/otel/sdk/metric/controller/basic"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
)
|
|
|
|
// This test demonstrates that it is relatively difficult to setup a
|
|
// Prometheus export pipeline:
|
|
//
|
|
// 1. The default boundaries are difficult to pass, should be []float instead of []number.Number
|
|
//
|
|
// TODO: Address this issue.
|
|
|
|
func ExampleNewExportPipeline() {
|
|
// Create a resource, with builtin attributes plus R=V.
|
|
res, err := resource.New(
|
|
context.Background(),
|
|
resource.WithAttributes(attribute.String("R", "V")),
|
|
)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// Create a meter
|
|
exporter, err := prometheus.NewExportPipeline(
|
|
prometheus.Config{},
|
|
controller.WithResource(res),
|
|
)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
meter := exporter.MeterProvider().Meter("example")
|
|
ctx := context.Background()
|
|
|
|
// Use two instruments
|
|
counter := metric.Must(meter).NewInt64Counter(
|
|
"a.counter",
|
|
metric.WithDescription("Counts things"),
|
|
)
|
|
recorder := metric.Must(meter).NewInt64ValueRecorder(
|
|
"a.valuerecorder",
|
|
metric.WithDescription("Records values"),
|
|
)
|
|
|
|
counter.Add(ctx, 100, attribute.String("key", "value"))
|
|
recorder.Record(ctx, 100, attribute.String("key", "value"))
|
|
|
|
// GET the HTTP endpoint
|
|
var input bytes.Buffer
|
|
resp := httptest.NewRecorder()
|
|
req, err := http.NewRequest("GET", "/", &input)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
exporter.ServeHTTP(resp, req)
|
|
data, err := ioutil.ReadAll(resp.Result().Body)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
fmt.Print(string(data))
|
|
|
|
// Output:
|
|
// # HELP a_counter Counts things
|
|
// # TYPE a_counter counter
|
|
// a_counter{R="V",key="value"} 100
|
|
// # HELP a_valuerecorder Records values
|
|
// # TYPE a_valuerecorder histogram
|
|
// a_valuerecorder_bucket{R="V",key="value",le="+Inf"} 1
|
|
// a_valuerecorder_sum{R="V",key="value"} 100
|
|
// a_valuerecorder_count{R="V",key="value"} 1
|
|
}
|
|
|
|
func ExampleInstallNewPipeline() {
|
|
exporter, err := prometheus.InstallNewPipeline(prometheus.Config{})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// Expose metrics via HTTP in your handler/muxer
|
|
http.Handle("/metrics", exporter)
|
|
|
|
// When exiting from your process, call Stop for last collection cycle.
|
|
defer func() {
|
|
err := exporter.Controller().Stop(context.TODO())
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}()
|
|
}
|