profiler

Documentation

Overview

Package profiler enables the Cloud Profiler for the application.

Index

• func Run(opts ...option.ClientOption) func(context.Context) error
• func WithMutexProfiling() option.ClientOption
• func WithProject(project string) option.ClientOption
• func WithService(service string) option.ClientOption
• func WithVersion(version string) option.ClientOption
• type Option

Functions

func Run

func Run(opts ...option.ClientOption) func(context.Context) error

Run starts the Cloud Profiler with given options. It requires the following IAM roles:

• roles/cloudprofiler.agent

func WithMutexProfiling

func WithMutexProfiling() option.ClientOption

WithMutexProfiling enables mutex profiling.

func WithProject

func WithProject(project string) option.ClientOption

WithProject provides the GCP project ID.

func WithService

func WithService(service string) option.ClientOption

WithService provides the GCP service name.

func WithVersion

func WithVersion(version string) option.ClientOption

WithVersion provides the GCP service version.

Types

type Option

type Option = option.ClientOption

Option configures the profiler client.