-
Notifications
You must be signed in to change notification settings - Fork 9
/
client.go
197 lines (169 loc) · 4.77 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Package honeycombio provides a client to interact with the Honeycomb API.
//
// Documentation of the API can be found here: https://docs.honeycomb.io/api/
package honeycombio
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"strings"
"github.com/kvrhdn/go-honeycombio/internal/httputil"
)
// Config holds all configuration options for the client.
type Config struct {
// Required - the API key to use when sending request to Honeycomb.
APIKey string
// URL of the Honeycomb API, defaults to "https://api.honeycomb.io".
APIUrl string
// User agent to send with all requests, defaults to "go-honeycombio".
UserAgent string
// With debug enabled the client will log all requests and responses.
Debug bool
}
func defaultConfig() *Config {
return &Config{
APIKey: "",
APIUrl: "https://api.honeycomb.io",
UserAgent: "go-honeycombio",
Debug: false,
}
}
// Merge the given config by copying all non-blank values.
func (c *Config) merge(other *Config) {
if other.APIKey != "" {
c.APIKey = other.APIKey
}
if other.APIUrl != "" {
c.APIUrl = other.APIUrl
}
if other.UserAgent != "" {
c.UserAgent = other.UserAgent
}
if c.Debug || other.Debug {
c.Debug = true
}
}
// Client to interact with Honeycomb.
type Client struct {
apiKey string
apiURL *url.URL
userAgent string
httpClient *http.Client
Boards Boards
Columns Columns
Datasets Datasets
DerivedColumns DerivedColumns
Markers Markers
Queries Queries
QueryAnnotations QueryAnnotations
Triggers Triggers
}
// NewClient creates a new Honeycomb API client.
func NewClient(config *Config) (*Client, error) {
cfg := defaultConfig()
cfg.merge(config)
if cfg.APIKey == "" {
return nil, errors.New("APIKey must be configured")
}
apiURL, err := url.Parse(cfg.APIUrl)
if err != nil {
return nil, fmt.Errorf("could not parse APIUrl: %w", err)
}
httpClient := &http.Client{}
if cfg.Debug {
httpClient = httputil.WrapWithLogging(httpClient)
}
client := &Client{
apiKey: cfg.APIKey,
apiURL: apiURL,
userAgent: cfg.UserAgent,
httpClient: httpClient,
}
client.Boards = &boards{client: client}
client.Columns = &columns{client: client}
client.Datasets = &datasets{client: client}
client.DerivedColumns = &derivedColumns{client: client}
client.Markers = &markers{client: client}
client.Queries = &queries{client: client}
client.QueryAnnotations = &queryAnnotations{client: client}
client.Triggers = &triggers{client: client}
return client, nil
}
// ErrNotFound is returned when the requested item could not be found.
var ErrNotFound = errors.New("404 Not Found")
// performRequest against the Honeycomb API with the necessary headers and, if
// requestBody is not nil, a JSON body. The response is parsed in responseBody,
// if responseBody is not nil.
// Returns an error if the request failed, if the response contained a non-2xx
// status code or if parsing the response in responseBody failed. ErrNotFound
// is returned on a 404 response.
func (c *Client) performRequest(ctx context.Context, method, path string, requestBody, responseBody interface{}) error {
var body io.Reader
if requestBody != nil {
buf := new(bytes.Buffer)
err := json.NewEncoder(buf).Encode(requestBody)
if err != nil {
return err
}
body = buf
}
requestURL, err := c.apiURL.Parse(path)
if err != nil {
return err
}
req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
if err != nil {
return err
}
req.Header.Add("X-Honeycomb-Team", c.apiKey)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("User-Agent", c.userAgent)
resp, err := c.httpClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
if !httputil.Is2xx(resp.StatusCode) {
if resp.StatusCode == 404 {
return ErrNotFound
}
return errorFromResponse(resp)
}
if responseBody != nil {
err = json.NewDecoder(resp.Body).Decode(responseBody)
}
return err
}
func errorFromResponse(resp *http.Response) error {
errorMsg := attemptToExtractHoneycombioError(resp.Body)
if errorMsg == "" {
return fmt.Errorf("%s", resp.Status)
}
return fmt.Errorf("%s: %s", resp.Status, errorMsg)
}
type honeycombioError struct {
ErrorMessage string `json:"error"`
}
func attemptToExtractHoneycombioError(bodyReader io.Reader) string {
body, err := ioutil.ReadAll(bodyReader)
if err != nil {
return ""
}
var honeycombioErr honeycombioError
err = json.Unmarshal(body, &honeycombioErr)
if err != nil || honeycombioErr.ErrorMessage == "" {
return string(body)
}
return honeycombioErr.ErrorMessage
}
// urlEncodeDataset sanitizes the dataset name for when it is used as part of
// the URL.
func urlEncodeDataset(dataset string) string {
return strings.Replace(dataset, "/", "-", -1)
}