Documentation
¶
Overview ¶
Package vault contains functions to construct or augment an *http.Client that will integrate with the github.com/hashicorp/vault/api and collect traces to send to Datadog.
The easiest way to use this package is to create an *http.Client with NewHTTPClient, and put it in the Vault api.Config that is passed to api.NewClient.
If you are already using your own *http.Client with the Vault API, you can use the WrapHTTPClient function to wrap the client with the tracer code. Your *http.Client will continue to work as before, but will also capture traces.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHTTPClient ¶
NewHTTPClient returns an *http.Client for use in the Vault API config *api.Client. A set of options can be passed in for further configuration.
Example ¶
This is the most basic way to enable tracing with Vault.
package main
import (
"log"
"github.com/hashicorp/vault/api"
vaulttrace "github.com/DataDog/dd-trace-go/contrib/hashicorp/vault/v2"
)
func main() {
c, err := api.NewClient(&api.Config{
HttpClient: vaulttrace.NewHTTPClient(),
Address: "http://vault.mydomain.com:8200",
})
if err != nil {
log.Fatalf("Failed to create Vault client: %s\n", err)
}
// This call wil be traced
c.Logical().Read("/secret/key")
}
Output:
Example (WithOptions) ¶
NewHTTPClient can be called with additional options for further configuration.
package main
import (
"log"
"github.com/hashicorp/vault/api"
vaulttrace "github.com/DataDog/dd-trace-go/contrib/hashicorp/vault/v2"
)
func main() {
c, err := api.NewClient(&api.Config{
HttpClient: vaulttrace.NewHTTPClient(
vaulttrace.WithService("my.vault"),
vaulttrace.WithAnalytics(true),
),
Address: "http://vault.mydomain.com:8200",
})
if err != nil {
log.Fatalf("Failed to create Vault client: %s\n", err)
}
// This call wil be traced
c.Logical().Read("/secret/key")
}
Output:
func WrapHTTPClient ¶
WrapHTTPClient takes an existing *http.Client and wraps the underlying transport with tracing.
Example ¶
If you already have an http.Client that you're using, you can add tracing to it with WrapHTTPClient.
package main
import (
"fmt"
"log"
"net/http"
"github.com/hashicorp/vault/api"
vaulttrace "github.com/DataDog/dd-trace-go/contrib/hashicorp/vault/v2"
)
func main() {
// We use a custom *http.Client to talk to Vault.
c := &http.Client{
CheckRedirect: func(_ *http.Request, via []*http.Request) error {
if len(via) > 5 {
return fmt.Errorf("won't perform more than 5 redirects")
}
return nil
},
}
client, err := api.NewClient(&api.Config{
HttpClient: vaulttrace.WrapHTTPClient(c),
Address: "http://vault.mydomain.com:8200",
})
if err != nil {
log.Fatalf("Failed to create Vault client: %s\n", err)
}
// This call wil be traced
client.Logical().Read("/secret/key")
}
Output:
Example (WithOptions) ¶
WrapHTTPClient can be called with additional options to configure the integration.
package main
import (
"fmt"
"log"
"net/http"
"github.com/hashicorp/vault/api"
vaulttrace "github.com/DataDog/dd-trace-go/contrib/hashicorp/vault/v2"
)
func main() {
// We use a custom *http.Client to talk to Vault.
c := &http.Client{
CheckRedirect: func(_ *http.Request, via []*http.Request) error {
if len(via) > 5 {
return fmt.Errorf("won't perform more than 5 redirects")
}
return nil
},
}
client, err := api.NewClient(&api.Config{
HttpClient: vaulttrace.WrapHTTPClient(
c,
vaulttrace.WithService("my.vault"),
vaulttrace.WithAnalytics(true),
),
Address: "http://vault.mydomain.com:8200",
})
if err != nil {
log.Fatalf("Failed to create Vault client: %s\n", err)
}
// This call wil be traced
client.Logical().Read("/secret/key")
}
Output:
Types ¶
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
Option describes options for the Vault integration.
type OptionFn ¶
type OptionFn func(*config)
OptionFn represents options applicable to NewHTTPClient and WrapHTTPClient.
func WithAnalytics ¶
WithAnalytics enables or disables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithService ¶
WithService sets the given service name for the *http.Client.
Source Files