Skip to content

Commit

Permalink
prepare for release v1.0.0 - Update README and changelog (#216)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update README.md

* Update CHANGELOG.md

* Update CHANGELOG.md

* change the SDK version to 1.0.0

* resolve conflicts and corrected example

* remove rc tag

* Added PR 194

* Update README.md

* Update CHANGELOG.md
  • Loading branch information
bhautikpip committed Apr 15, 2020
1 parent 886d3aa commit 09036a6
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 19 deletions.
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
Release v1.0.0-rc.15 (2019-03-11)
Release v1.0.0 (2020-04-16)
================================
### SDK Breaking Changes
* Removed plugins under "github.com/aws/aws-xray-sdk-go/plugins/“ directory and removed deprecated xray.SQL API (sql.go file). [PR #215](https://github.com/aws/aws-xray-sdk-go/pull/215)
* Added Dummy flag support to reduce operation of non sampled traces. [PR #194](https://github.com/aws/aws-xray-sdk-go/pull/194)

### SDK Enhancements
* Benchmark improvements to remove error logs. [PR #210](https://github.com/aws/aws-xray-sdk-go/pull/210)
* Updates golangci-lint version. [PR #213](https://github.com/aws/aws-xray-sdk-go/pull/213)
* Benchmark instructions to run benchamrk suite, cpu profiling and memory profiling of SDK. [PR #214](https://github.com/aws/aws-xray-sdk-go/pull/214)

### SDK Bugs
* Fixes bug in reservoir test cases. [PR #212](https://github.com/aws/aws-xray-sdk-go/pull/212)

Release v1.0.0-rc.15 (2020-03-11)
================================
### SDK Breaking Changes
* Custom SQL driver. [PR #169](https://github.com/aws/aws-xray-sdk-go/pull/169)
Expand Down
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Build Status](https://travis-ci.org/aws/aws-xray-sdk-go.svg?branch=master)](https://travis-ci.org/aws/aws-xray-sdk-go)

# AWS X-Ray SDK for Go <sup><sup><sup>(RC)</sup></sup></sup>
# AWS X-Ray SDK for Go

![Screenshot of the AWS X-Ray console](/images/example.png?raw=true)

Expand Down Expand Up @@ -29,15 +29,19 @@ go get -u -t github.com/aws/aws-xray-sdk-go/...

## Installing using Go Modules

The X-Ray SDK for Go is currently in release candidate (RC) stage. The latest RC of the SDK is the recommended version and will be supported before the GA release of v1, which is tracked in this [issue](https://github.com/aws/aws-xray-sdk-go/issues/205).
The latest version of the SDK is the recommended version.

If you are using Go 1.11 and above, you can install the SDK using Go Modules. You must specify the latest RC version when installing the SDK, like so:
If you are using Go 1.11 and above, you can install the SDK using Go Modules (in project's go.mod), like so:

```
go get github.com/aws/aws-xray-sdk-go@v1.0.0-rc.15
go get github.com/aws/aws-xray-sdk-go
```

To get a different specific release version of the SDK use `@<tag>` in your `go get` command.
To get a different specific release version of the SDK use `@<tag>` in your `go get` command. Also, to get the rc version use this command with the specific version.

```
go get github.com/aws/aws-xray-sdk-go@v1.0.0
```

## Installing using Dep
If you are using Go 1.9 and above, you can also use [Dep](https://github.com/golang/dep) to add the SDK to your application's dependencies.
Expand Down Expand Up @@ -67,22 +71,14 @@ The GitHub issues are intended for bug reports and feature requests. For help an

The [developer guide](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-go.html) provides in-depth guidance on using the AWS X-Ray service and the AWS X-Ray SDK for Go.

See [aws-xray-sdk-go-sample](https://github.com/aws-samples/aws-xray-sdk-go-sample) for a sample application that provides example of tracing SQL queries, incoming and outgoing request. Follow [README instructions](https://github.com/aws-samples/aws-xray-sdk-go-sample/blob/master/README.md) in that repository to get started with sample application.

## Quick Start

**Configuration**

```go
import (
"context"

"github.com/aws/aws-xray-sdk-go/xray"

// Importing the plugins enables collection of AWS resource information at runtime.
// Every plugin should be imported after "github.com/aws/aws-xray-sdk-go/xray" library.
_ "github.com/aws/aws-xray-sdk-go/plugins/ec2"
_ "github.com/aws/aws-xray-sdk-go/plugins/beanstalk"
_ "github.com/aws/aws-xray-sdk-go/plugins/ecs"
)
import "github.com/aws/aws-xray-sdk-go/xray"

func init() {
xray.Configure(xray.Config{
Expand Down Expand Up @@ -226,6 +222,7 @@ func main() {
row, err := db.QueryRowContext(ctx, "SELECT 1") // Use as normal
}
```

**Lambda**

```
Expand Down Expand Up @@ -260,7 +257,7 @@ func HandleRequest(ctx context.Context, name string) (string, error) {
_, subseg := xray.BeginSubsegment(ctx, "subsegment-name")
subseg.Close(nil)

db := xray.SQL("postgres", "postgres://user:password@host:port/db")
db := xray.SQLContext("postgres", "postgres://user:password@host:port/db")
row, _ := db.QueryRow(ctx, "SELECT 1")

return fmt.Sprintf("Hello %s!", name), nil
Expand Down
2 changes: 1 addition & 1 deletion xray/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
)

// SDKVersion records the current X-Ray Go SDK version.
const SDKVersion = "1.0.0-rc.15"
const SDKVersion = "1.0.0"

// SDKType records which X-Ray SDK customer uses.
const SDKType = "X-Ray for Go"
Expand Down

0 comments on commit 09036a6

Please sign in to comment.