summaryrefslogtreecommitdiff
path: root/vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go')
-rw-r--r--vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go24
1 files changed, 12 insertions, 12 deletions
diff --git a/vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go b/vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go
index 2b5e78686..fabf952c4 100644
--- a/vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go
+++ b/vendor/go.opentelemetry.io/contrib/instrumentation/runtime/doc.go
@@ -5,6 +5,18 @@
//
// The metric events produced are:
//
+// go.memory.used By Memory used by the Go runtime.
+// go.memory.limit By Go runtime memory limit configured by the user, if a limit exists.
+// go.memory.allocated By Memory allocated to the heap by the application.
+// go.memory.allocations {allocation} Count of allocations to the heap by the application.
+// go.memory.gc.goal By Heap size target for the end of the GC cycle.
+// go.goroutine.count {goroutine} Count of live goroutines.
+// go.processor.limit {thread} The number of OS threads that can execute user-level Go code simultaneously.
+// go.config.gogc % Heap size target percentage configured by the user, otherwise 100.
+//
+// When the OTEL_GO_X_DEPRECATED_RUNTIME_METRICS environment variable is set to
+// true, the following deprecated metrics are produced:
+//
// runtime.go.cgo.calls - Number of cgo calls made by the current process
// runtime.go.gc.count - Number of completed garbage collection cycles
// runtime.go.gc.pause_ns (ns) Amount of nanoseconds in GC stop-the-world pauses
@@ -19,16 +31,4 @@
// runtime.go.mem.heap_sys (bytes) Bytes of heap memory obtained from the OS
// runtime.go.mem.live_objects - Number of live objects is the number of cumulative Mallocs - Frees
// runtime.uptime (ms) Milliseconds since application was initialized
-//
-// When the OTEL_GO_X_DEPRECATED_RUNTIME_METRICS environment variable is set to
-// false, the metrics produced are:
-//
-// go.memory.used By Memory used by the Go runtime.
-// go.memory.limit By Go runtime memory limit configured by the user, if a limit exists.
-// go.memory.allocated By Memory allocated to the heap by the application.
-// go.memory.allocations {allocation} Count of allocations to the heap by the application.
-// go.memory.gc.goal By Heap size target for the end of the GC cycle.
-// go.goroutine.count {goroutine} Count of live goroutines.
-// go.processor.limit {thread} The number of OS threads that can execute user-level Go code simultaneously.
-// go.config.gogc % Heap size target percentage configured by the user, otherwise 100.
package runtime // import "go.opentelemetry.io/contrib/instrumentation/runtime"