fix(readme.md): update readme (#23)

epsagon · Apr 13, 2020 · d50cb67 · d50cb67
1 parent 018666f
commit d50cb67
Showing 1 changed file with 106 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,54 @@
-# Epsagon Instrumentation for Go
+<p align="center">
+  <a href="https://epsagon.com" target="_blank" align="center">
+    <img src="https://cdn2.hubspot.net/hubfs/4636301/Positive%20RGB_Logo%20Horizontal%20-01.svg" width="300">
+  </a>
+  <br />
+</p>
 
-[![Build Status][1]][2] [![GoDoc][3]][4]
+[![Build Status](https://travis-ci.com/epsagon/epsagon-go.svg?token=wsveVqcNtBtmq6jpZfSf&branch=master)](https://travis-ci.com/epsagon/epsagon-go)
+[![GoDoc](https://godoc.org/github.com/epsagon/epsagon-go?status.svg)](https://godoc.org/github.com/epsagon/epsagon-go)
 
-[1]: https://travis-ci.com/epsagon/epsagon-go.svg?branch=master
-[2]: https://travis-ci.com/epsagon/epsagon-go
-[3]: https://godoc.org/github.com/epsagon/epsagon-go?status.svg
-[4]: https://godoc.org/github.com/epsagon/epsagon-go
+# Epsagon Tracing for Go
 
-## Installing
-```
+This package provides tracing to Go applications for the collection of distributed tracing and performance metrics in [Epsagon](https://dashboard.epsagon.com/?utm_source=github).
+
+
+## Contents
+
+- [Installation](#installation)
+- [Frameworks](#frameworks)
+- [Integrations](#integrations)
+- [Configuration](#configuration)
+- [Getting Help](#getting-help)
+- [Opening Issues](#opening-issues)
+- [License](#license)
+
+
+## Installation
+
+To install Epsagon, simply run:
+```sh
 go get github.com/epsagon/epsagon-go
 ```
+
 Or using `dep`:
-```
+```sh
 dep ensure -add github.com/epsagon/epsagon-go
 ```
-## Usage
 
-### To wrap a lambda handler
+## Frameworks
+
+The following frameworks are supported by Epsagon:
+
+|Framework                               |Supported Version          |Auto-tracing Supported                               |
+|----------------------------------------|---------------------------|-----------------------------------------------------|
+|[AWS Lambda](#aws-lambda)               |All                        |<ul><li>- [ ]</li></ul> |
+
+
+### AWS Lambda
+
+Tracing Lambda functions can be done in the following method:
+
 ```go
 package main
 
@@ -36,16 +67,37 @@ func myHandler(request events.APIGatewayProxyRequest) (events.APIGatewayProxyRes
 func main() {
 	log.Println("enter main")
 	lambda.Start(epsagon.WrapLambdaHandler(
-        epsagon.NewTracerConfig("APPLICATION-NAME","EPSAGON-TOKEN"),
+        epsagon.NewTracerConfig("app-name-stage","epsagon-token"),
         myHandler))
 }
 ```
 
-`epsagon.WrapLambdaHandler` will wrap your handler with code that will start a tracer that will wait for events and will send them to the collector when the lambda finishes
 
-### Wrapping other libraries
-#### aws-sdk-go
+## 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:
+
+```go
+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:
+
 ```go
 import (
 ...
@@ -55,19 +107,44 @@ import (
 	sess := epsagonawswrapper.WrapSession(session.Must(session.NewSession()))
 	svcSQS := sqs.New(sess)
 ```
-#### net/http
-Wrapping http requests using the net/http library can be done by wrapping the client:
-```go
-import (
-	"github.com/epsagon/epsagon-go/wrappers/net/http"
-...
-	client := epsagonhttp.Wrap(http.Client{})
-	resp, err := client.Get(anyurl)
-```
 
 ## Configuration
-The epsagon.Config structure that is sent to `WraphLambdaHandler` has some fields to customize epsagons behaviour:
-- `MetadataOnly`: Boolean flag to make sure to only send metadata information and not the data itself
-- `Debug`: Will print debug information form epsagon
-- `CollectorURL`: Set the collector's address instead of getting it from `EPSAGON_COLLECTOR_URL` or using epsagon's default in the same aws region
-- `Token`: Your epsagon token (The default is to attempt to read this from `EPSAGON_TOKEN` environment variable)
+
+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                                            |
+
+
+
+## Getting Help
+
+If you have any issue around using the library or the product, please don't hesitate to:
+
+* Use the [documentation](https://docs.epsagon.com).
+* 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