go_expvar/

directory
v0.0.0-...-9673f84 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2023 License: BSD-3-Clause

README

Go Expvar Integration

Go graph

Overview

Track the memory usage of your Go services and collect metrics instrumented from Go's expvar package.

If you prefer to instrument your Go code using only dogstats-go, you can still use this integration to collect memory-related metrics.

Setup

Installation

The Go Expvar check is packaged with the Agent, so install the Agent anywhere you run Go services to collect metrics.

Configuration
Prepare the service

If your Go service doesn't use the expvar package already, import it (import "expvar"). If you don't want to instrument your own metrics with expvar - that is you only want to collect your service's memory metrics - import the package using the blank identifier (import _ "expvar"). If your service doesn't already listen for HTTP requests (with the http package), make it listen locally just for the Datadog Agent.

Host

To configure this check for an Agent running on a host:

Connect the Agent
  1. Edit the file go_expvar.d/conf.yaml, in the conf.d/ folder at the root of your Agent's configuration directory. See the sample go_expvar.d/conf.yaml for all available configuration options.

    Note: If you don't configure a metrics list, the Agent still collects memstat metrics. Use metrics to tell the Agent which expvar vars to collect.

  2. Restart the Agent.

Note: The Go Expvar integration can potentially emit custom metrics, which may impact your billing. By default, there is a limit of 350 metrics. If you require additional metrics, contact Datadog support.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Parameter Value
<INTEGRATION_NAME> go_expvar
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"expvar_url": "http://%%host%%:8080"}
Validation

Run the Agent's status subcommand and look for go_expvar under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The Go-Expvar check does not include any events.

Service Checks

The Go-Expvar check does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Directories

Path Synopsis
tests
compose
Demo of the expvar package.
Demo of the expvar package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL