Menu
Grafana Cloud

Go integration for Grafana Cloud

The Go programming language (golang) is a programming language designed at Google to make programmers more productive in applications with strong networking concurrency needs. This integration enables the agent to send metrics to Grafana Cloud along with a useful default dashboard for visualization.

This integration includes 1 pre-built dashboard to help monitor and visualize Go metrics.

Before you begin

This integration monitors the Go runtime for a process that exposes metrics through Golang client.

Please check the docs for details on how to expose your Go runtime metrics.

Install Go integration for Grafana Cloud

  1. In your Grafana Cloud stack, click Connections in the left-hand menu.
  2. Find Go and click its tile to open the integration.
  3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Go metrics to your Grafana Cloud instance.
  4. Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Go setup.

Post-install configuration for the Go integration

After enabling the metrics generation, you should instruct Grafana Agent to scrape your go runtime instance.

The client_golang lib exposes a /metrics endpoint. To scrape it, add the provided snippet to your agent configuration file.

Make sure to change targets in the snippet according to your environment.

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml
    - job_name: integrations/go
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
      - targets: ['localhost:8080']

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Go integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml
integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/go
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
      - targets: ['localhost:8080']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The Go integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

  • Go runtime metrics

Go Runtime Metrics

Go Runtime Metrics

Metrics

The most important metrics provided by the Go integration, which are used on the pre-built dashboard, are as follows:

  • go_gc_duration_seconds
  • go_goroutines
  • go_info
  • go_memstats_alloc_bytes_total
  • go_memstats_buck_hash_sys_bytes
  • go_memstats_frees_total
  • go_memstats_gc_sys_bytes
  • go_memstats_heap_inuse_bytes
  • go_memstats_heap_sys_bytes
  • go_memstats_mallocs_total
  • go_memstats_mcache_sys_bytes
  • go_memstats_mspan_sys_bytes
  • go_memstats_next_gc_bytes
  • go_memstats_stack_sys_bytes
  • go_memstats_sys_bytes

Changelog

md
# 0.0.6 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.5 - January 2023

* Update dashboard panels to TimeSeries.

# 0.0.4 - September 2022

* Update dashboard panels.

# 0.0.3 - January 2022

* Update mixin to latest version:
  - Use `job` variable in panels legend

# 0.0.2 - October 2021

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'

# 0.0.1 - November 2020

* Initial release

Cost

By connecting your Go instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.