Skip to content

[Dashboard Request] Golang Runtime Metrics DashboardΒ #6007

@makeavish

Description

@makeavish

πŸ“ Dashboard Request Template

1. Dashboard Name

Golang Runtime Metrics Dashboard


2. Suggested Dashboard Sections and Panels - Tweak based on relevancy and available metrics

Section: Memory Metrics

  • Panel: Heap Allocation - Displays the current number of bytes allocated on the heap.
  • Panel: Heap Idle - Shows memory allocated by the OS but not actively used by the Go runtime.
  • Panel: Heap In Use - Shows the memory currently in use for heap objects.
  • Panel: Heap Objects - Displays the number of allocated heap objects.
  • Panel: Heap Released - Memory released back to the OS.
  • Panel: Heap Sys - Total bytes obtained from the system for the heap.
  • Panel: GC Pause Duration - Duration of garbage collection pauses.
  • Panel: GC Count - Displays the number of completed garbage collection cycles.
  • Panel: GC Forced - Shows the number of times garbage collection has been forced.

Section: Goroutines Metrics

  • Panel: Active Goroutines - Displays the current number of active goroutines.
  • Panel: Total Goroutines Created - Shows the total number of goroutines created since the program started.

Section: GC (Garbage Collection) Metrics

  • Panel: CPU Fraction - Displays the fraction of total CPU time spent in garbage collection.
  • Panel: GC Sys - Bytes used by garbage collection metadata.

Section: CPU Metrics

  • Panel: Goroutine Execution Time - Total time in nanoseconds spent in goroutine execution.
  • Panel: GC Time - Displays time spent in garbage collection in nanoseconds.
  • Panel: System Time - Displays time spent by the Go runtime in system-related tasks.

Section: Thread Metrics

  • Panel: OS Threads - Displays the number of OS threads created by the Go runtime.

Section: Stack Metrics

  • Panel: Stack In Use - Memory currently used for goroutine stacks.
  • Panel: Stack Sys - Displays the total bytes obtained from the system for stacks.

Section: Mutex and Semaphores Metrics

  • Panel: Mutex Wait Time - Time spent waiting on mutex locks.
  • Panel: Mutex Lock Count - Number of mutex lock operations.

3. Expected Variables

  • deployment.environment
  • service.name

4. Additional Comments or Requirements

No additional requirements for now.


πŸ“‹ Notes

Please review the CONTRIBUTING.md for guidelines on dashboard structure, naming conventions, and how to submit a pull request.

Instrument with otel golang runtime

Refer this dashboard for inspiration: https://grafana.com/grafana/dashboards/14061-go-runtime-metrics/


Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions