Skip to content
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.

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

Add runtime metrics #7

Closed
wants to merge 4 commits into from
Closed
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
5 changes: 5 additions & 0 deletions src/checkoutservice/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,11 @@ func main() {
}
}()

meter := mp.Meter("checkoutservice")
if err := recordRuntimeMetrics(meter); err != nil {
log.Fatal(err)
}

err := runtime.Start(runtime.WithMinimumReadMemStatsInterval(time.Second))
if err != nil {
log.Fatal(err)
Expand Down
46 changes: 46 additions & 0 deletions src/checkoutservice/runtimeMetrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package main

import (
"context"
"runtime"

"go.opentelemetry.io/otel/metric"
)

func recordRuntimeMetrics(meter metric.Meter) error {
// Create metric instruments
gcPause, err := meter.Float64ObservableGauge("go_gc_pause")
if err != nil {
return err
}

allocatedMemory, err := meter.Float64ObservableGauge("go_allocated_memory")
if err != nil {
return err
}

memoryObtainedFromSystem, err := meter.Float64ObservableGauge("go_memory_obtained_from_system")
if err != nil {
return err
}

// Record the runtime stats periodically
if _, err := meter.RegisterCallback(
func(ctx context.Context, o metric.Observer) error {
var memStats runtime.MemStats
runtime.ReadMemStats(&memStats)

o.ObserveFloat64(gcPause, float64(memStats.PauseTotalNs)/1e6) // GC Pause in ms
o.ObserveFloat64(allocatedMemory, float64(memStats.Alloc)) // Allocated Memory in B
o.ObserveFloat64(memoryObtainedFromSystem, float64(memStats.Sys)) // Memory Obtained From System in B
return nil
},
gcPause, allocatedMemory, memoryObtainedFromSystem,
); err != nil {
return err
}

return nil
}
38 changes: 30 additions & 8 deletions src/otelcollector/otelcol-config-extras.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,33 @@
## Note: the spanmetrics exporter must be included in the exporters array
## if overriding the traces pipeline.
##
# exporters:
# otlphttp/example:
# endpoint: <your-endpoint-url>
#
# service:
# pipelines:
# traces:
# exporters: [spanmetrics, otlphttp/example]
processors:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm thinking whether this should move to a separate folder, e.g.: /instana, just as Petr did, so that it's easy to merge updates from upstream later. The /instana folder can host any changes specific to Instana, including sample configuration, documents, etc.

resource:
attributes:
- key: service.instance.id
value: otel-demo
action: upsert

exporters:
otlp/instana:
endpoint:
headers:
x-instana-key:
tls:
insecure: true

service:
pipelines:
traces:
receivers: [otlp]
processors: [transform, batch, resource]
exporters: [otlp, debug, spanmetrics, otlp/instana]
metrics:
receivers: [otlp, spanmetrics]
processors: [batch, resource]
exporters: [otlphttp/prometheus, debug, otlp/instana]
logs:
receivers: [otlp]
processors: [batch, resource]
exporters: [opensearch, debug]

Check failure on line 40 in src/otelcollector/otelcol-config-extras.yml

View workflow job for this annotation

GitHub Actions / yamllint

40:1 [empty-lines] too many blank lines (1 > 0)
4 changes: 4 additions & 0 deletions src/paymentservice/charge.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const { FlagdProvider} = require('@openfeature/flagd-provider');
const flagProvider = new FlagdProvider();

const logger = require('./logger');
const runtimeMetrics = require('./runtimeMetrics');
const tracer = trace.getTracer('paymentservice');
const meter = metrics.getMeter('paymentservice');
const transactionsCounter = meter.createCounter('app.payment.transactions')
Expand Down Expand Up @@ -64,5 +65,8 @@ module.exports.charge = async request => {
const { units, nanos, currencyCode } = request.amount;
logger.info({transactionId, cardType, lastFourDigits, amount: { units, nanos, currencyCode }}, "Transaction complete.");
transactionsCounter.add(1, {"app.payment.currency": currencyCode})

runtimeMetrics.setupRuntimeMetrics();

return { transactionId }
}
6 changes: 5 additions & 1 deletion src/paymentservice/opentelemetry.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const {awsEc2Detector, awsEksDetector} = require('@opentelemetry/resource-detect
const {containerDetector} = require('@opentelemetry/resource-detector-container')
const {gcpDetector} = require('@opentelemetry/resource-detector-gcp')
const {envDetector, hostDetector, osDetector, processDetector} = require('@opentelemetry/resources')
const {RuntimeNodeInstrumentation} = require('@opentelemetry/instrumentation-runtime-node')

const sdk = new opentelemetry.NodeSDK({
traceExporter: new OTLPTraceExporter(),
Expand All @@ -20,6 +21,9 @@ const sdk = new opentelemetry.NodeSDK({
'@opentelemetry/instrumentation-fs': {
requireParentSpan: true,
},
}),
new RuntimeNodeInstrumentation({
monitoringPrecision: 5000,
})
],
metricReader: new PeriodicExportingMetricReader({
Expand All @@ -38,4 +42,4 @@ const sdk = new opentelemetry.NodeSDK({
],
})

sdk.start();
sdk.start();
62 changes: 59 additions & 3 deletions src/paymentservice/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions src/paymentservice/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,19 @@
"@grpc/proto-loader": "0.7.13",
"@openfeature/flagd-provider": "0.13.0",
"@openfeature/server-sdk": "1.14.0",
"@opentelemetry/api": "1.8.0",
"@opentelemetry/auto-instrumentations-node": "0.46.1",
"@opentelemetry/core": "1.24.1",
"@opentelemetry/resources": "1.24.1",
"@opentelemetry/api": "1.8.0",
"@opentelemetry/sdk-metrics": "1.24.1",
"@opentelemetry/exporter-trace-otlp-grpc": "0.51.1",
"@opentelemetry/exporter-metrics-otlp-grpc": "0.51.1",
"@opentelemetry/sdk-node": "0.51.1",
"@opentelemetry/exporter-trace-otlp-grpc": "0.51.1",
"@opentelemetry/instrumentation-runtime-node": "^0.10.0",
"@opentelemetry/resource-detector-alibaba-cloud": "0.28.9",
"@opentelemetry/resource-detector-aws": "1.5.0",
"@opentelemetry/resource-detector-container": "0.3.9",
"@opentelemetry/resource-detector-gcp": "0.29.9",
"@opentelemetry/resources": "1.24.1",
"@opentelemetry/sdk-metrics": "1.24.1",
"@opentelemetry/sdk-node": "0.51.1",
"grpc-js-health-check": "1.1.0",
"pino": "8.16.1",
"simple-card-validator": "1.1.0",
Expand Down
Loading
Loading