1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
opentelemetry-go/exporters/stdout/stdoutmetric/example_test.go
Sinan Ülker 7fc24d2b14
Update the metric Export interface to accept a *ResourceMetrics instead of ResourceMetrics (#3853)
* Change the signature of Export method

* Pass tests for otlp exporter

* Pass tests for otlp grpc and http packages

* Update opencensus bridge

* Refactor and pass tests for stdoutmetric package

* Update periodic reader tests

* Update changelog

* Apply suggestions

* Apply suggestions

* Update CHANGELOG.md

---------

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2023-03-16 10:58:43 -07:00

331 lines
9.3 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 stdoutmetric_test
import (
"context"
"encoding/json"
"os"
"time"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
"go.opentelemetry.io/otel/sdk/instrumentation"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/metric/metricdata"
"go.opentelemetry.io/otel/sdk/resource"
semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
)
var (
// Sat Jan 01 2000 00:00:00 GMT+0000.
now = time.Date(2000, time.January, 01, 0, 0, 0, 0, time.FixedZone("GMT", 0))
res = resource.NewSchemaless(
semconv.ServiceName("stdoutmetric-example"),
)
mockData = metricdata.ResourceMetrics{
Resource: res,
ScopeMetrics: []metricdata.ScopeMetrics{
{
Scope: instrumentation.Scope{Name: "example", Version: "v0.0.1"},
Metrics: []metricdata.Metrics{
{
Name: "requests",
Description: "Number of requests received",
Unit: "1",
Data: metricdata.Sum[int64]{
IsMonotonic: true,
Temporality: metricdata.DeltaTemporality,
DataPoints: []metricdata.DataPoint[int64]{
{
Attributes: attribute.NewSet(attribute.String("server", "central")),
StartTime: now,
Time: now.Add(1 * time.Second),
Value: 5,
},
},
},
},
{
Name: "system.cpu.time",
Description: "Accumulated CPU time spent",
Unit: "s",
Data: metricdata.Sum[float64]{
IsMonotonic: true,
Temporality: metricdata.CumulativeTemporality,
DataPoints: []metricdata.DataPoint[float64]{
{
Attributes: attribute.NewSet(attribute.String("state", "user")),
StartTime: now,
Time: now.Add(1 * time.Second),
Value: 0.5,
},
},
},
},
{
Name: "latency",
Description: "Time spend processing received requests",
Unit: "ms",
Data: metricdata.Histogram[float64]{
Temporality: metricdata.DeltaTemporality,
DataPoints: []metricdata.HistogramDataPoint[float64]{
{
Attributes: attribute.NewSet(attribute.String("server", "central")),
StartTime: now,
Time: now.Add(1 * time.Second),
Count: 10,
Bounds: []float64{1, 5, 10},
BucketCounts: []uint64{1, 3, 6, 0},
Sum: 57,
},
},
},
},
{
Name: "system.memory.usage",
Description: "Memory usage",
Unit: "By",
Data: metricdata.Gauge[int64]{
DataPoints: []metricdata.DataPoint[int64]{
{
Attributes: attribute.NewSet(attribute.String("state", "used")),
Time: now.Add(1 * time.Second),
Value: 100,
},
},
},
},
{
Name: "temperature",
Description: "CPU global temperature",
Unit: "cel(1 K)",
Data: metricdata.Gauge[float64]{
DataPoints: []metricdata.DataPoint[float64]{
{
Attributes: attribute.NewSet(attribute.String("server", "central")),
Time: now.Add(1 * time.Second),
Value: 32.4,
},
},
},
},
},
},
},
}
)
func Example() {
// Print with a JSON encoder that indents with two spaces.
enc := json.NewEncoder(os.Stdout)
enc.SetIndent("", " ")
exp, err := stdoutmetric.New(
stdoutmetric.WithEncoder(enc),
stdoutmetric.WithoutTimestamps(),
)
if err != nil {
panic(err)
}
// Register the exporter with an SDK via a periodic reader.
sdk := metric.NewMeterProvider(
metric.WithResource(res),
metric.WithReader(metric.NewPeriodicReader(exp)),
)
ctx := context.Background()
// This is where the sdk would be used to create a Meter and from that
// instruments that would make measurements of your code. To simulate that
// behavior, call export directly with mocked data.
_ = exp.Export(ctx, &mockData)
// Ensure the periodic reader is cleaned up by shutting down the sdk.
_ = sdk.Shutdown(ctx)
//Output:
// {
// "Resource": [
// {
// "Key": "service.name",
// "Value": {
// "Type": "STRING",
// "Value": "stdoutmetric-example"
// }
// }
// ],
// "ScopeMetrics": [
// {
// "Scope": {
// "Name": "example",
// "Version": "v0.0.1",
// "SchemaURL": ""
// },
// "Metrics": [
// {
// "Name": "requests",
// "Description": "Number of requests received",
// "Unit": "1",
// "Data": {
// "DataPoints": [
// {
// "Attributes": [
// {
// "Key": "server",
// "Value": {
// "Type": "STRING",
// "Value": "central"
// }
// }
// ],
// "StartTime": "0001-01-01T00:00:00Z",
// "Time": "0001-01-01T00:00:00Z",
// "Value": 5
// }
// ],
// "Temporality": "DeltaTemporality",
// "IsMonotonic": true
// }
// },
// {
// "Name": "system.cpu.time",
// "Description": "Accumulated CPU time spent",
// "Unit": "s",
// "Data": {
// "DataPoints": [
// {
// "Attributes": [
// {
// "Key": "state",
// "Value": {
// "Type": "STRING",
// "Value": "user"
// }
// }
// ],
// "StartTime": "0001-01-01T00:00:00Z",
// "Time": "0001-01-01T00:00:00Z",
// "Value": 0.5
// }
// ],
// "Temporality": "CumulativeTemporality",
// "IsMonotonic": true
// }
// },
// {
// "Name": "latency",
// "Description": "Time spend processing received requests",
// "Unit": "ms",
// "Data": {
// "DataPoints": [
// {
// "Attributes": [
// {
// "Key": "server",
// "Value": {
// "Type": "STRING",
// "Value": "central"
// }
// }
// ],
// "StartTime": "0001-01-01T00:00:00Z",
// "Time": "0001-01-01T00:00:00Z",
// "Count": 10,
// "Bounds": [
// 1,
// 5,
// 10
// ],
// "BucketCounts": [
// 1,
// 3,
// 6,
// 0
// ],
// "Min": {},
// "Max": {},
// "Sum": 57
// }
// ],
// "Temporality": "DeltaTemporality"
// }
// },
// {
// "Name": "system.memory.usage",
// "Description": "Memory usage",
// "Unit": "By",
// "Data": {
// "DataPoints": [
// {
// "Attributes": [
// {
// "Key": "state",
// "Value": {
// "Type": "STRING",
// "Value": "used"
// }
// }
// ],
// "StartTime": "0001-01-01T00:00:00Z",
// "Time": "0001-01-01T00:00:00Z",
// "Value": 100
// }
// ]
// }
// },
// {
// "Name": "temperature",
// "Description": "CPU global temperature",
// "Unit": "cel(1 K)",
// "Data": {
// "DataPoints": [
// {
// "Attributes": [
// {
// "Key": "server",
// "Value": {
// "Type": "STRING",
// "Value": "central"
// }
// }
// ],
// "StartTime": "0001-01-01T00:00:00Z",
// "Time": "0001-01-01T00:00:00Z",
// "Value": 32.4
// }
// ]
// }
// }
// ]
// }
// ]
// }
// {
// "Resource": [
// {
// "Key": "service.name",
// "Value": {
// "Type": "STRING",
// "Value": "stdoutmetric-example"
// }
// }
// ],
// "ScopeMetrics": null
// }
}