epsagon-go

README

Epsagon Tracing for Go

This package provides tracing to Go applications for the collection of distributed tracing and performance metrics in Epsagon.

Contents

• Installation
• Frameworks
• Integrations
• Configuration
• Getting Help
• Opening Issues
• License

Installation

To install Epsagon, simply run:

go get github.com/epsagon/epsagon-go

Or using dep:

dep ensure -add github.com/epsagon/epsagon-go

Frameworks

The following frameworks are supported by Epsagon:

Framework	Supported Version	Auto-tracing Supported
AWS Lambda	All	- [ ]

AWS Lambda

Tracing Lambda functions can be done in the following method:

package main

import (
	"github.com/aws/aws-lambda-go/events"
	"github.com/aws/aws-lambda-go/lambda"
	"github.com/epsagon/epsagon-go/epsagon"
	"log"
)

func myHandler(request events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error) {
	log.Println("In myHandler, received body: ", request.Body)
	return events.APIGatewayProxyResponse{Body: request.Body, StatusCode: 200}, nil
}

func main() {
	log.Println("enter main")
	lambda.Start(epsagon.WrapLambdaHandler(
        epsagon.NewTracerConfig("app-name-stage","epsagon-token"),
        myHandler))
}

Integrations

Epsagon provides out-of-the-box instrumentation (tracing) for many popular frameworks and libraries.

Library	Supported Version
net/http	Fully supported
aws-sdk-go	>=1.10.0

net/http

Wrapping http requests using the net/http library can be done by wrapping the client:

import (
	"github.com/epsagon/epsagon-go/wrappers/net/http"
...
	client := epsagonhttp.Wrap(http.Client{})
	resp, err := client.Get(anyurl)

aws-sdk-go

Wrapping of aws-sdk-go is done through the Session object that has to be created to communicate with AWS:

import (
...
	"github.com/epsagon/epsagon-go/wrappers/aws/aws-sdk-go/aws"
)
    ...
	sess := epsagonawswrapper.WrapSession(session.Must(session.NewSession()))
	svcSQS := sqs.New(sess)

Configuration

Advanced options can be configured as a parameter to the Config struct to the WrapLambdaHandler or as environment variables.

Parameter	Environment Variable	Type	Default	Description
Token	EPSAGON_TOKEN	String	-	Epsagon account token
ApplicationName	-	String	-	Application name that will be set for traces
MetadataOnly	EPSAGON_METADATA	Boolean	true	Whether to send only the metadata (True) or also the payloads (False)
CollectorURL	EPSAGON_COLLECTOR_URL	String	-	The address of the trace collector to send trace to
Debug	EPSAGON_DEBUG	Boolean	False	Enable debug prints for troubleshooting
SendTimeout	EPSAGON_SEND_TIMEOUT_SEC	String	1s	The timeout duration to send the traces to the trace collector

Getting Help

If you have any issue around using the library or the product, please don't hesitate to:

• Use the documentation.
• Use the help widget inside the product.
• Open an issue in GitHub.

Opening Issues

If you encounter a bug with the Epsagon library for Go, we want to hear about it.

When opening a new issue, please provide as much information about the environment:

• Library version, Go runtime version, dependencies, etc.
• Snippet of the usage.
• A reproducible example can really help.

The GitHub issues are intended for bug reports and feature requests. For help and questions about Epsagon, use the help widget inside the product.

License

Provided under the MIT license. See LICENSE for details.

Copyright 2020, Epsagon