profiler

Documentation

Overview

Package profiler periodically collects and sends profiles to the Datadog API. Use Start to start the profiler. An API key needs to be specified by means of the WithAPIKey option.

Example

This example illustrates how to run (and later stop) the Datadog Profiler.

package main

import (
	"log"

	"gopkg.in/DataDog/dd-trace-go.v1/profiler"
)

func main() {
	err := profiler.Start(
		profiler.WithAPIKey("123key"),
		profiler.WithService("users-db"),
		profiler.WithEnv("staging"),
		profiler.WithTags("version:1.2.0"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer profiler.Stop()

	// ...
}

Index

• Constants
• Variables
• func Start(opts ...Option) error
• func Stop()
• type Option
  • func CPUDuration(d time.Duration) Option
  • func WithAPIKey(key string) Option
  • func WithEnv(env string) Option
  • func WithPeriod(d time.Duration) Option
  • func WithProfileTypes(types ...ProfileType) Option
  • func WithService(name string) Option
  • func WithStatsd(client StatsdClient) Option
  • func WithTags(tags ...string) Option
  • func WithURL(url string) Option
  • func WithVersion(version string) Option
• type ProfileType
  • func (t ProfileType) String() string
• type StatsdClient

Examples

• Package

Constants

const (
	// DefaultMutexFraction specifies the mutex profile fraction to be used with the mutex profiler.
	// For more information or for changing this value, check runtime.SetMutexProfileFraction.
	DefaultMutexFraction = 10

	// DefaultBlockRate specifies the default block profiling rate used by the block profiler.
	// For more information or for changing this value, check runtime.SetBlockProfileRate.
	DefaultBlockRate = 100

	// DefaultPeriod specifies the default period at which profiles will be collected.
	DefaultPeriod = time.Minute

	// DefaultDuration specifies the default length of the CPU profile snapshot.
	DefaultDuration = time.Second * 15
)

Variables

var ErrMissingAPIKey = errors.New("API key is missing; provide it using the profiler.WithAPIKey option")

ErrMissingAPIKey is returned when an API key was not found by the profiler.

Functions

func Start

func Start(opts ...Option) error

Start starts the profiler. It may return an error if an API key is not provided by means of the WithAPIKey option, or if a hostname is not found.

func Stop

func Stop()

Stop stops the profiler.

Types

type Option

type Option func(*config)

An Option is used to configure the profiler's behaviour.

func CPUDuration

func CPUDuration(d time.Duration) Option

CPUDuration specifies the length at which to collect CPU profiles.

func WithAPIKey

func WithAPIKey(key string) Option

WithAPIKey specifies the API key to use when connecting to the Datadog API.

func WithEnv

func WithEnv(env string) Option

WithEnv specifies the environment to which these profiles should be registered.

func WithPeriod

func WithPeriod(d time.Duration) Option

WithPeriod specifies the interval at which to collect profiles.

func WithProfileTypes

func WithProfileTypes(types ...ProfileType) Option

WithProfileTypes specifies the profile types to be collected by the profiler.

func WithService

func WithService(name string) Option

WithService specifies the service name to attach to a profile.

func WithStatsd

func WithStatsd(client StatsdClient) Option

WithStatsd specifies an optional statsd client to use for metrics. By default, no metrics are sent.

func WithTags

func WithTags(tags ...string) Option

WithTags specifies a set of tags to be attached to the profiler. These may help filter the profiling view based on various information.

func WithURL

func WithURL(url string) Option

WithURL specifies the HTTP URL for the Datadog Profiling API.

func WithVersion

func WithVersion(version string) Option

WithVersion specifies the service version tag to attach to profiles

type ProfileType

type ProfileType int

ProfileType represents a type of profile that the profiler is able to run.

const (
	// HeapProfile reports memory allocation samples; used to monitor current
	// and historical memory usage, and to check for memory leaks.
	HeapProfile ProfileType = iota
	// CPUProfile determines where a program spends its time while actively consuming
	// CPU cycles (as opposed to while sleeping or waiting for I/O).
	CPUProfile
	// BlockProfile shows where goroutines block waiting on synchronization primitives
	// (including timer channels). Block profile is not enabled by default.
	BlockProfile
	// MutexProfile reports the lock contentions. When you think your CPU is not fully utilized due
	// to a mutex contention, use this profile. Mutex profile is not enabled by default.
	MutexProfile
)

func (ProfileType) String

func (t ProfileType) String() string

type StatsdClient

type StatsdClient interface {
	// Count counts how many times an event happened, at the given rate using the given tags.
	Count(event string, times int64, tags []string, rate float64) error
	// Timing creates a distribution of the values registered as the duration of a certain event.
	Timing(event string, duration time.Duration, tags []string, rate float64) error
}

StatsdClient implementations can count and time certain event occurrences that happen in the profiler.