Merge pull request #474 from shogo82148/improve-doc-for-xrayaws

improve document for the xrayaws package

xray/doc.go

@@ -0,0 +1,2 @@
+// Package xray provides a simple API for tracing and monitoring AWS X-Ray.
+package xray

xrayaws-v2/doc.go

@@ -0,0 +1,11 @@
+// Package xrayaws provides AWS X-Ray tracing for AWS SDK for Go v2.
+//
+//	cfg, err := config.LoadDefaultConfig(ctx, xrayaws.WithXRay())
+//	if err != nil {
+//		panic(err)
+//	}
+//	svc := dynamodb.NewFromConfig(cfg)
+//
+//	// the following requests are traced.
+//	dynamo.ListTables(ctx, &dynamodb.ListTablesInput{})
+package xrayaws

xrayaws-v2/whitelist/whitelist.go

@@ -1,3 +1,4 @@
+// Package whitelist provides whitelist of parameters for aws api.
 package whitelist
 
 import (
@@ -24,7 +25,7 @@ type Operation struct {
 	ResponseParameters  []string               `json:"response_parameters,omitempty"`
 }
 
-// Descriptor is a rule for recording the paremeter.
+// Descriptor is a rule for recording the parameter.
 type Descriptor struct {
 	Map      bool   `json:"map,omitempty"`
 	GetKeys  bool   `json:"get_keys"`

xrayaws/doc.go

@@ -0,0 +1,9 @@
+// Package xrayaws provides AWS X-Ray tracing for AWS SDK for Go v1.
+//
+//	sess := session.Must(session.NewSession())
+//	svc := dynamodb.New(sess)
+//	xrayaws.Client(svc.Client) // install AWS X-Ray tracer
+//
+//	// the following requests are traced.
+//	dynamo.ListTablesWithContext(ctx, &dynamodb.ListTablesInput{})
+package xrayaws

xrayaws/whitelist/whitelist.go

@@ -1,3 +1,4 @@
+// Package whitelist provides the whitelist of parameters for aws api.
 package whitelist
 
 import (
@@ -24,7 +25,7 @@ type Operation struct {
 	ResponseParameters  []string               `json:"response_parameters,omitempty"`
 }
 
-// Descriptor is a rule for recording the paremeter.
+// Descriptor is a rule for recording the parameter.
 type Descriptor struct {
 	Map      bool   `json:"map,omitempty"`
 	GetKeys  bool   `json:"get_keys"`