Skip to content

Commit 09036a6

Browse files
authored
prepare for release v1.0.0 - Update README and changelog (#216)
* 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
1 parent 886d3aa commit 09036a6

File tree

3 files changed

+30
-19
lines changed

3 files changed

+30
-19
lines changed

CHANGELOG.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
Release v1.0.0-rc.15 (2019-03-11)
1+
Release v1.0.0 (2020-04-16)
2+
================================
3+
### SDK Breaking Changes
4+
* 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)
5+
* Added Dummy flag support to reduce operation of non sampled traces. [PR #194](https://github.com/aws/aws-xray-sdk-go/pull/194)
6+
7+
### SDK Enhancements
8+
* Benchmark improvements to remove error logs. [PR #210](https://github.com/aws/aws-xray-sdk-go/pull/210)
9+
* Updates golangci-lint version. [PR #213](https://github.com/aws/aws-xray-sdk-go/pull/213)
10+
* 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)
11+
12+
### SDK Bugs
13+
* Fixes bug in reservoir test cases. [PR #212](https://github.com/aws/aws-xray-sdk-go/pull/212)
14+
15+
Release v1.0.0-rc.15 (2020-03-11)
216
================================
317
### SDK Breaking Changes
418
* Custom SQL driver. [PR #169](https://github.com/aws/aws-xray-sdk-go/pull/169)

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Build Status](https://travis-ci.org/aws/aws-xray-sdk-go.svg?branch=master)](https://travis-ci.org/aws/aws-xray-sdk-go)
22

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

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

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

3030
## Installing using Go Modules
3131

32-
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).
32+
The latest version of the SDK is the recommended version.
3333

34-
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:
34+
If you are using Go 1.11 and above, you can install the SDK using Go Modules (in project's go.mod), like so:
3535

3636
```
37-
go get github.com/aws/aws-xray-sdk-go@v1.0.0-rc.15
37+
go get github.com/aws/aws-xray-sdk-go
3838
```
3939

40-
To get a different specific release version of the SDK use `@<tag>` in your `go get` command.
40+
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.
41+
42+
```
43+
go get github.com/aws/[email protected]
44+
```
4145

4246
## Installing using Dep
4347
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.
@@ -67,22 +71,14 @@ The GitHub issues are intended for bug reports and feature requests. For help an
6771

6872
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.
6973

74+
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.
75+
7076
## Quick Start
7177

7278
**Configuration**
7379

7480
```go
75-
import (
76-
"context"
77-
78-
"github.com/aws/aws-xray-sdk-go/xray"
79-
80-
// Importing the plugins enables collection of AWS resource information at runtime.
81-
// Every plugin should be imported after "github.com/aws/aws-xray-sdk-go/xray" library.
82-
_ "github.com/aws/aws-xray-sdk-go/plugins/ec2"
83-
_ "github.com/aws/aws-xray-sdk-go/plugins/beanstalk"
84-
_ "github.com/aws/aws-xray-sdk-go/plugins/ecs"
85-
)
81+
import "github.com/aws/aws-xray-sdk-go/xray"
8682

8783
func init() {
8884
xray.Configure(xray.Config{
@@ -226,6 +222,7 @@ func main() {
226222
row, err := db.QueryRowContext(ctx, "SELECT 1") // Use as normal
227223
}
228224
```
225+
229226
**Lambda**
230227

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

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

266263
return fmt.Sprintf("Hello %s!", name), nil

xray/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
)
2525

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

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

0 commit comments

Comments
 (0)