Skip to content

api: support for trace flag #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2020
Merged

api: support for trace flag #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cmd/src/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"flag"
"fmt"
"io/ioutil"
"log"
"net/http"
"os"
"strings"
Expand Down Expand Up @@ -208,6 +209,9 @@ func (a *apiRequest) do() error {
if cfg.AccessToken != "" {
req.Header.Set("Authorization", "token "+cfg.AccessToken)
}
if *a.flags.trace {
req.Header.Set("X-Sourcegraph-Should-Trace", "true")
}
for k, v := range cfg.AdditionalHeaders {
req.Header.Set(k, v)
}
Expand All @@ -220,6 +224,11 @@ func (a *apiRequest) do() error {
}
defer resp.Body.Close()

// Check trace header before we potentially early exit
if *a.flags.trace {
log.Printf("x-trace: %s", resp.Header.Get("x-trace"))
}

// Our request may have failed before the reaching GraphQL endpoint, so
// confirm the status code. You can test this easily with e.g. an invalid
// endpoint like -endpoint=https://google.com
Expand Down Expand Up @@ -276,13 +285,15 @@ func (a *apiRequest) do() error {
// API requests. e.g. the ability to turn any CLI command into a curl command.
type apiFlags struct {
getCurl *bool
trace *bool
}

// newAPIFlags creates the API flags. It should be invoked once at flag setup
// time.
func newAPIFlags(flagSet *flag.FlagSet) *apiFlags {
return &apiFlags{
getCurl: flagSet.Bool("get-curl", false, "Print the curl command for executing this query and exit (WARNING: includes printing your access token!)"),
trace: flagSet.Bool("trace", false, "Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing"),
}
}

Expand Down