From 41431ddfb00b273356be7ba221dcbb8fea47af08 Mon Sep 17 00:00:00 2001 From: Kapil Verma Date: Wed, 23 Nov 2022 17:45:02 +0530 Subject: [PATCH] docs fixes --- go/core/README.md | 22 ++++++------- go/database/sql/README.md | 30 ++++++++--------- go/gorrila/mux/README.md | 68 +++++++++++++++++++-------------------- go/net/http/README.md | 2 +- 4 files changed, 61 insertions(+), 61 deletions(-) diff --git a/go/core/README.md b/go/core/README.md index eaec9bad..98ddf424 100644 --- a/go/core/README.md +++ b/go/core/README.md @@ -16,13 +16,13 @@ Users are given control over what tags they want to append by using `core.Commen ```go type CommenterConfig struct { - EnableDBDriver bool - EnableRoute bool - EnableFramework bool - EnableController bool - EnableAction bool - EnableTraceparent bool - EnableApplication bool + EnableDBDriver bool + EnableRoute bool + EnableFramework bool + EnableController bool + EnableAction bool + EnableTraceparent bool + EnableApplication bool } ``` @@ -30,8 +30,8 @@ Users can also set the values for some static tags by using `core.StaticTags` st ```go type StaticTags struct { - Application string - DriverName string + Application string + DriverName string } ``` @@ -39,7 +39,7 @@ These two structs together form the `core.CommenterOptions` struct, which is use ```go type CommenterOptions struct { - Config CommenterConfig - Tags StaticTags + Config CommenterConfig + Tags StaticTags } ``` \ No newline at end of file diff --git a/go/database/sql/README.md b/go/database/sql/README.md index 9459083d..459fdf41 100644 --- a/go/database/sql/README.md +++ b/go/database/sql/README.md @@ -15,14 +15,14 @@ Due to inherent nature of Go, the safer way to pass information from framework t ```go import ( - gosql "github.com/google/sqlcommenter/go/database/sql" - sqlcommentercore "github.com/google/sqlcommenter/go/core" - _ "github.com/lib/pq" // or any other database driver + gosql "github.com/google/sqlcommenter/go/database/sql" + sqlcommentercore "github.com/google/sqlcommenter/go/core" + _ "github.com/lib/pq" // or any other database driver ) db, err := gosql.Open("", "", sqlcommentercore.CommenterOptions{ - Config: sqlcommentercore.CommenterConfig{:bool} - Tags : sqlcommentercore.StaticTags{: string} // optional + Config: sqlcommentercore.CommenterConfig{:bool} + Tags : sqlcommentercore.StaticTags{: string} // optional }) ``` @@ -32,22 +32,22 @@ Users are given control over what tags they want to append by using `core.Commen ```go type CommenterOptions struct { - EnableDBDriver bool - EnableTraceparent bool // OpenTelemetry trace information - EnableRoute bool // applicable for web frameworks - EnableFramework bool // applicable for web frameworks - EnableController bool // applicable for web frameworks - EnableAction bool // applicable for web frameworks - EnableApplication bool // applicable for web frameworks + EnableDBDriver bool + EnableTraceparent bool // OpenTelemetry trace information + EnableRoute bool // applicable for web frameworks + EnableFramework bool // applicable for web frameworks + EnableController bool // applicable for web frameworks + EnableAction bool // applicable for web frameworks + EnableApplication bool // applicable for web frameworks } ``` -Users can also provide static tags they want to use by using `core.StaticTags` struct. These tags are optional +Users can also provide static tags they want to use by using `core.StaticTags` struct. These tags are optional. If not provided, the `Application` tag will get auto-populated from the user-project's module-name in `go.mod`. `DriverName` is set to the driver-name provided in `gosql.Open(driverName, ...)` call. ```go type StaticTags struct { - Application string - DriverName string + Application string + DriverName string } ``` diff --git a/go/gorrila/mux/README.md b/go/gorrila/mux/README.md index afd09ac0..0e533a9e 100644 --- a/go/gorrila/mux/README.md +++ b/go/gorrila/mux/README.md @@ -20,14 +20,14 @@ import ( "net/http" sqlcommentermux "github.com/google/sqlcommenter/go/gorrila/mux" - "github.com/gorilla/mux" + "github.com/gorilla/mux" ) func runApp() { - r := mux.NewRouter() - r.Use(sqlcommentermux.SQLCommenterMiddleware) + r := mux.NewRouter() + r.Use(sqlcommentermux.SQLCommenterMiddleware) - r.HandleFunc("/", ActionHome).Methods("GET") + r.HandleFunc("/", ActionHome).Methods("GET") http.ListenAndServe(":8081", r) } @@ -38,49 +38,49 @@ func runApp() { ```go import ( "context" - "log" - "net/http" + "log" + "net/http" sqlcommentermux "github.com/google/sqlcommenter/go/gorrila/mux" - "github.com/gorilla/mux" - "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" - "go.opentelemetry.io/otel" - stdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" - "go.opentelemetry.io/otel/propagation" - sdktrace "go.opentelemetry.io/otel/sdk/trace" + "github.com/gorilla/mux" + "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" + "go.opentelemetry.io/otel" + stdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" + "go.opentelemetry.io/otel/propagation" + sdktrace "go.opentelemetry.io/otel/sdk/trace" ) func main() { tp, err := initTracer() - if err != nil { - log.Fatal(err) - } - defer func() { - if err := tp.Shutdown(context.Background()); err != nil { - log.Printf("Error shutting down tracer provider: %v", err) - } - }() + if err != nil { + log.Fatal(err) + } + defer func() { + if err := tp.Shutdown(context.Background()); err != nil { + log.Printf("Error shutting down tracer provider: %v", err) + } + }() - r := mux.NewRouter() - r.Use(otelmux.Middleware("sqlcommenter sample-server"), sqlcommentermux.SQLCommenterMiddleware) + r := mux.NewRouter() + r.Use(otelmux.Middleware("sqlcommenter sample-server"), sqlcommentermux.SQLCommenterMiddleware) - r.HandleFunc("/", ActionHome).Methods("GET") + r.HandleFunc("/", ActionHome).Methods("GET") http.ListenAndServe(":8081", r) } func initTracer() (*sdktrace.TracerProvider, error) { - exporter, err := stdout.New(stdout.WithPrettyPrint()) - if err != nil { - return nil, err - } - tp := sdktrace.NewTracerProvider( - sdktrace.WithSampler(sdktrace.AlwaysSample()), - sdktrace.WithBatcher(exporter), - ) - otel.SetTracerProvider(tp) - otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) - return tp, nil + exporter, err := stdout.New(stdout.WithPrettyPrint()) + if err != nil { + return nil, err + } + tp := sdktrace.NewTracerProvider( + sdktrace.WithSampler(sdktrace.AlwaysSample()), + sdktrace.WithBatcher(exporter), + ) + otel.SetTracerProvider(tp) + otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) + return tp, nil } ``` diff --git a/go/net/http/README.md b/go/net/http/README.md index 612fa89f..2268dfd9 100644 --- a/go/net/http/README.md +++ b/go/net/http/README.md @@ -14,7 +14,7 @@ This is a low-level package that can be used to prepare SQLCommeneterTags out of ```go import ( - sqlcommenterhttp "github.com/google/sqlcommenter/go/net/http" + sqlcommenterhttp "github.com/google/sqlcommenter/go/net/http" ) requestTags := sqlcommenterhttp.NewHTTPRequestTags(framework string, route string, action string)