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

feat: make metrics build specific #237

Merged
merged 5 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
97 changes: 97 additions & 0 deletions instrumentation/opentelemetry/internal/metrics/linux_metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
//go:build linux

package metrics

import (
"fmt"
"os"
"path/filepath"
"strconv"
"strings"

"github.com/tklauser/go-sysconf"
)

const procStatArrayLength = 52

var (
clkTck = getClockTicks()
pageSize = float64(os.Getpagesize())
)

type processStats struct {
utime float64
stime float64
cutime float64
cstime float64
rss float64
}

type linuxMetrics struct {
memory float64
cpuSecondsTotal float64
}

func newSystemMetrics() (systemMetrics, error) {
lm := &linuxMetrics{}
stats, err := lm.processStatsFromPid(os.Getpid())
if err != nil {
return nil, err

Check warning on line 39 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L39

Added line #L39 was not covered by tests
}
lm.memory = stats.rss * pageSize
lm.cpuSecondsTotal = (stats.stime + stats.utime + stats.cstime + stats.cutime) / clkTck
return lm, nil
}

func (lm *linuxMetrics) getMemory() float64 {
return lm.memory
}

func (lm *linuxMetrics) getCPU() float64 {
return lm.cpuSecondsTotal
}

func (lm *linuxMetrics) processStatsFromPid(pid int) (*processStats, error) {
Copy link
Contributor

@puneet-traceable puneet-traceable Jul 25, 2024

Choose a reason for hiding this comment

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

no tests for this function? It's fine for this but in general for testing such scenarios

  1. either file should become a parameter to the function and then you can create custom files to test.
  2. can pass an io.Reader to the function to read file. (*os.File) implements an io.Reader. During test you can use a mock version.

procFilepath := filepath.Join("/proc", strconv.Itoa(pid), "stat")
var err error
thugrock7 marked this conversation as resolved.
Show resolved Hide resolved
if procStatFileBytes, err := os.ReadFile(filepath.Clean(procFilepath)); err == nil {
thugrock7 marked this conversation as resolved.
Show resolved Hide resolved
if stat, err := lm.parseProcStatFile(procStatFileBytes, procFilepath); err == nil {
if err != nil {
thugrock7 marked this conversation as resolved.
Show resolved Hide resolved
return nil, err

Check warning on line 60 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L60

Added line #L60 was not covered by tests
}
return stat, nil
}
return nil, err

Check warning on line 64 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L64

Added line #L64 was not covered by tests
}
return nil, err

Check warning on line 66 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L66

Added line #L66 was not covered by tests
}

// ref: /proc/pid/stat section of https://man7.org/linux/man-pages/man5/proc.5.html
func (lm *linuxMetrics) parseProcStatFile(bytesArr []byte, procFilepath string) (*processStats, error) {
varkey98 marked this conversation as resolved.
Show resolved Hide resolved
infos := strings.Split(string(bytesArr), " ")
if len(infos) != procStatArrayLength {
return nil, fmt.Errorf("%s file could not be parsed", procFilepath)

Check warning on line 73 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L73

Added line #L73 was not covered by tests
}
return &processStats{
utime: parseFloat(infos[13]),
stime: parseFloat(infos[14]),
cutime: parseFloat(infos[15]),
cstime: parseFloat(infos[16]),
rss: parseFloat(infos[23]),
}, nil
}

func parseFloat(val string) float64 {
floatVal, _ := strconv.ParseFloat(val, 64)
return floatVal
}

// sysconf for go. claims to work without cgo or external binaries
// https://pkg.go.dev/github.com/tklauser/go-sysconf@v0.3.14#section-readme
func getClockTicks() float64 {
clktck, err := sysconf.Sysconf(sysconf.SC_CLK_TCK)
if err != nil {
return float64(100)

Check warning on line 94 in instrumentation/opentelemetry/internal/metrics/linux_metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/linux_metrics.go#L94

Added line #L94 was not covered by tests
}
return float64(clktck)
}
57 changes: 57 additions & 0 deletions instrumentation/opentelemetry/internal/metrics/metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package metrics

import (
"context"
"fmt"
"go.opentelemetry.io/otel"
varkey98 marked this conversation as resolved.
Show resolved Hide resolved
"go.opentelemetry.io/otel/metric"
"log"
)

const meterName = "goagent.hypertrace.org/metrics"

type systemMetrics interface {
getMemory() float64
getCPU() float64
}

func InitializeSystemMetrics() {
meterProvider := otel.GetMeterProvider()
meter := meterProvider.Meter(meterName)
err := setUpMetricRecorder(meter)
if err != nil {
log.Printf("error initializing metrics, failed to setup metric recorder: %v\n", err)

Check warning on line 23 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L23

Added line #L23 was not covered by tests
}
}

func setUpMetricRecorder(meter metric.Meter) error {
if meter == nil {
return fmt.Errorf("error while setting up metric recorder: meter is nil")

Check warning on line 29 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L29

Added line #L29 was not covered by tests
}
cpuSeconds, err := meter.Float64ObservableCounter("hypertrace.agent.cpu.seconds.total", metric.WithDescription("Metric to monitor total CPU seconds"))
if err != nil {
return fmt.Errorf("error while setting up cpu seconds metric counter: %v", err)

Check warning on line 33 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L33

Added line #L33 was not covered by tests
}
memory, err := meter.Float64ObservableGauge("hypertrace.agent.memory", metric.WithDescription("Metric to monitor memory usage"))
if err != nil {
return fmt.Errorf("error while setting up memory metric counter: %v", err)

Check warning on line 37 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L37

Added line #L37 was not covered by tests
}
// Register the callback function for both cpu_seconds and memory observable gauges
_, err = meter.RegisterCallback(
func(ctx context.Context, result metric.Observer) error {
sysMetrics, err := newSystemMetrics()
if err != nil {
return err

Check warning on line 44 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L44

Added line #L44 was not covered by tests
}
result.ObserveFloat64(cpuSeconds, sysMetrics.getCPU())
result.ObserveFloat64(memory, sysMetrics.getMemory())
return nil
},
cpuSeconds, memory,
)
if err != nil {
log.Fatalf("failed to register callback: %v", err)
return err

Check warning on line 54 in instrumentation/opentelemetry/internal/metrics/metrics.go

View check run for this annotation

Codecov / codecov/patch

instrumentation/opentelemetry/internal/metrics/metrics.go#L53-L54

Added lines #L53 - L54 were not covered by tests
}
return nil
}
17 changes: 17 additions & 0 deletions instrumentation/opentelemetry/internal/metrics/noop_metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
//go:build !linux

package metrics

type noopMetrics struct{}

func newSystemMetrics() (systemMetrics, error) {
return &noopMetrics{}, nil
}

func (nm *noopMetrics) getMemory() float64 {
return 0
}

func (nm *noopMetrics) getCPU() float64 {
return 0
}
120 changes: 0 additions & 120 deletions instrumentation/opentelemetry/internal/metrics/system_metrics.go

This file was deleted.

Loading