stackimpact

README

StackImpact Go Agent

Description

StackImpact is a performance profiling and monitoring service for production Go applications. It gives you continuous function-level visibility into application performance, such as CPU hot spots and memory allocations, allowing to optimize applications and troubleshoot issues before they impact customers. Learn more at stackimpact.com.

StackImpact agent (this package) reports profiles and metrics to the Dashboard.

Requirements

Linux or OS X. Go version 1.5+.

Getting started

Create StackImpact account

Sign up for a free account at stackimpact.com.

Installing the agent

Install the Go agent by running

go get github.com/stackimpact/stackimpact-go

And import the package github.com/stackimpact/stackimpact-go in your application.

Configuring the agent

Start the agent by specifying agent key and application name. The agent key can be found in your account's Configuration section.

agent := stackimpact.NewAgent();
agent.Configure("agent key here", "MyGoApp")

Other initialization options are (set before calling Configure):

• agent.DashboardAddress (Optional) Used by on-premises deployments only.
• agent.HostName (Optional) By default host name will be the OS hostname.
• agent.Debug (Optional) Enables debug logging.

Example:

package main

import (
  	"fmt"
  	"net/http"

  	"github.com/stackimpact/stackimpact-go"
)

func handler(w http.ResponseWriter, r *http.Request) {
  	fmt.Fprintf(w, "Hello world!")
}

func main() {
  	agent := stackimpact.NewAgent()
  	agent.Configure("agent key here", "Basic Go Server")

  	http.HandleFunc("/", handler)
    http.ListenAndServe(":8080", nil)
}

Analyzing performance data in the Dashboard

Once your application is restarted, start observing regular and anomaly-triggered CPU, memory, IO, and other execution profiles as well as process metrics in the Dashboard.

Troubleshooting

To enable debug logging, add agent.Debug = true to startup options. If debug log doesn't give you any hints on how to fix a problem, please report it to our support team in your account's Support section.

Overhead

Reporting CPU and network and system profiles requires regular and anomaly-triggered profiling and tracing activation for short periods of time. Unlike memory profiling and process-level metric reporting, they produce some overhead when active. The agent makes sure the overhead stays within 2% and has no effect on application in any way.

Documentation

Index

• type Agent
  • func NewAgent() *Agent
  • func (a *Agent) Configure(agentKey string, appName string)

Types

type Agent

type Agent struct {
	DashboardAddress string
	HostName         string
	Debug            bool
	// contains filtered or unexported fields
}

func NewAgent

func NewAgent() *Agent

func (*Agent) Configure

func (a *Agent) Configure(agentKey string, appName string)