-
Notifications
You must be signed in to change notification settings - Fork 8
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
95 changes: 95 additions & 0 deletions
95
instrumentation/opentelemetry/internal/metrics/linux_metrics.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
//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 | ||
} | ||
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) { | ||
procFilepath := filepath.Join("/proc", strconv.Itoa(pid), "stat") | ||
procStatFileBytes, err := os.ReadFile(filepath.Clean(procFilepath)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
stat, err := lm.parseProcStatFile(procStatFileBytes, procFilepath) | ||
if err != nil { | ||
return nil, err | ||
} | ||
return stat, nil | ||
} | ||
|
||
// 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) | ||
} | ||
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) | ||
} | ||
return float64(clktck) | ||
} |
28 changes: 28 additions & 0 deletions
28
instrumentation/opentelemetry/internal/metrics/linux_metrics_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
//go:build linux | ||
|
||
package metrics | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
const ( | ||
// Mock data simulating /proc/[pid]/stat content | ||
mockData = "85 (md) I 2 0 0 0 -1 698880 0 0 0 0 100 200 300 400 0 -20 1 0 223 0 550 18437615 0 0 0 0 0 0 0 2647 0 1 0 0 17 1 0 0 0 0 0 0 0 0 0 0 0 0 0" | ||
) | ||
|
||
func TestParseProcStatFile(t *testing.T) { | ||
lm := &linuxMetrics{} | ||
procFilepath := "/proc/123/stat" | ||
|
||
stat, err := lm.parseProcStatFile([]byte(mockData), procFilepath) | ||
assert.NoError(t, err, "unexpected error while parsing proc stat file") | ||
|
||
assert.Equal(t, 100.0, stat.utime, "utime does not match expected value") | ||
assert.Equal(t, 200.0, stat.stime, "stime does not match expected value") | ||
assert.Equal(t, 300.0, stat.cutime, "cutime does not match expected value") | ||
assert.Equal(t, 400.0, stat.cstime, "cstime does not match expected value") | ||
assert.Equal(t, 550.0, stat.rss, "rss does not match expected value") | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
package metrics | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"log" | ||
|
||
"go.opentelemetry.io/otel" | ||
varkey98 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"go.opentelemetry.io/otel/metric" | ||
) | ||
|
||
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) | ||
} | ||
} | ||
|
||
func setUpMetricRecorder(meter metric.Meter) error { | ||
if meter == nil { | ||
return fmt.Errorf("error while setting up metric recorder: meter is nil") | ||
} | ||
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) | ||
} | ||
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) | ||
} | ||
// 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 | ||
} | ||
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 | ||
} | ||
return nil | ||
} |
17 changes: 17 additions & 0 deletions
17
instrumentation/opentelemetry/internal/metrics/noop_metrics.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
120
instrumentation/opentelemetry/internal/metrics/system_metrics.go
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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