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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// vespa visit command
// Author: arnej
package cmd
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
"time"
"github.com/spf13/cobra"
"github.com/vespa-engine/vespa/client/go/internal/util"
"github.com/vespa-engine/vespa/client/go/internal/vespa"
)
type visitArgs struct {
contentCluster string
fieldSet string
selection string
makeFeed bool
jsonLines bool
pretty bool
debugMode bool
chunkCount int
from string
to string
slices int
sliceId int
bucketSpace string
bucketSpaces []string
waitSecs int
cli *CLI
}
func (v *visitArgs) writeBytes(b []byte) {
v.cli.Stdout.Write(b)
}
func (v *visitArgs) writeString(s string) {
v.writeBytes([]byte(s))
}
func (v *visitArgs) debugPrint(s string) {
if v.debugMode {
v.cli.printDebug(s)
}
}
func (v *visitArgs) dumpDocuments(documents []DocumentBlob) {
comma := false
pretty := false
if v.makeFeed {
comma = true
pretty = v.pretty
} else if !v.jsonLines {
return
}
for _, value := range documents {
if pretty {
var prettyJSON bytes.Buffer
parseError := json.Indent(&prettyJSON, value.blob, "", " ")
if parseError != nil {
v.writeBytes(value.blob)
} else {
v.writeBytes(prettyJSON.Bytes())
}
} else {
v.writeBytes(value.blob)
}
if comma {
v.writeString(",\n")
} else {
v.writeString("\n")
}
}
}
var totalDocCount int
func newVisitCmd(cli *CLI) *cobra.Command {
var (
vArgs visitArgs
)
cmd := &cobra.Command{
Use: "visit",
Short: "Retrieve and print all documents from Vespa",
Long: `Retrieve and print all documents from Vespa.
By default prints each document received on its own line (JSONL format).
`,
Example: `$ vespa visit # get documents from any cluster
$ vespa visit --content-cluster search # get documents from cluster named "search"
$ vespa visit --field-set "[id]" # list document IDs
`,
Args: cobra.MaximumNArgs(0),
DisableAutoGenTag: true,
SilenceUsage: true,
RunE: func(cmd *cobra.Command, args []string) error {
vArgs.cli = cli
result := checkArguments(vArgs)
if !result.Success {
return fmt.Errorf("argument error: %s", result.Message)
}
service, err := documentService(cli, vArgs.waitSecs)
if err != nil {
return err
}
result = probeHandler(service, cli)
if result.Success {
result = visitClusters(&vArgs, service)
}
if !result.Success {
return fmt.Errorf("visit failed: %s", result.Message)
}
vArgs.debugPrint(fmt.Sprintf("sum of 'documentCount': %d", totalDocCount))
return nil
},
}
cmd.Flags().StringVar(&vArgs.contentCluster, "content-cluster", "*", `Which content cluster to visit documents from`)
cmd.Flags().StringVar(&vArgs.fieldSet, "field-set", "", `Which fieldset to ask for`)
cmd.Flags().StringVar(&vArgs.selection, "selection", "", `Select subset of cluster`)
cmd.Flags().BoolVar(&vArgs.debugMode, "debug-mode", false, `Print debugging output`)
cmd.Flags().BoolVar(&vArgs.jsonLines, "json-lines", true, `Output documents as JSON lines`)
cmd.Flags().BoolVar(&vArgs.makeFeed, "make-feed", false, `Output JSON array suitable for vespa-feeder`)
cmd.Flags().BoolVar(&vArgs.pretty, "pretty-json", false, `Format pretty JSON`)
cmd.Flags().IntVar(&vArgs.chunkCount, "chunk-count", 1000, `Chunk by count`)
cmd.Flags().StringVar(&vArgs.from, "from", "", `Timestamp to visit from, in seconds`)
cmd.Flags().StringVar(&vArgs.to, "to", "", `Timestamp to visit up to, in seconds`)
cmd.Flags().IntVar(&vArgs.sliceId, "slice-id", -1, `The number of the slice this visit invocation should fetch`)
cmd.Flags().IntVar(&vArgs.slices, "slices", -1, `Split the document corpus into this number of independent slices`)
cmd.Flags().StringSliceVar(&vArgs.bucketSpaces, "bucket-space", []string{"global", "default"}, `The "default" or "global" bucket space`)
cli.bindWaitFlag(cmd, 0, &vArgs.waitSecs)
return cmd
}
func getEpoch(timeStamp string) (int64, error) {
t, err := strconv.ParseInt(timeStamp, 10, 64)
if err != nil {
t, err := time.Parse(time.RFC3339, timeStamp)
if err != nil {
return 0, err
}
return t.Unix(), nil
}
return t, nil
}
func checkArguments(vArgs visitArgs) (res util.OperationResult) {
if vArgs.slices > 0 || vArgs.sliceId > -1 {
if !(vArgs.slices > 0 && vArgs.sliceId > -1) {
return util.Failure("Both 'slices' and 'slice-id' must be set")
}
if vArgs.sliceId >= vArgs.slices {
return util.Failure("The 'slice-id' must be in range [0, slices)")
}
}
// to and from will support RFC3339 format soon, add more validation then
if vArgs.from != "" {
_, err := getEpoch(vArgs.from)
if err != nil {
return util.Failure("Invalid 'from' argument: '" + vArgs.from + "': " + err.Error())
}
}
if vArgs.to != "" {
_, err := getEpoch(vArgs.to)
if err != nil {
return util.Failure("Invalid 'to' argument: '" + vArgs.to + "': " + err.Error())
}
}
for _, b := range vArgs.bucketSpaces {
switch b {
case
"default",
"global":
// Do nothing
default:
return util.Failure("Invalid 'bucket-space' argument '" + b + "', must be 'default' or 'global'")
}
}
return util.Success("")
}
type HandlersInfo struct {
Handlers []struct {
HandlerId string `json:"id"`
HandlerClass string `json:"class"`
HandlerBundle string `json:"bundle"`
ServerBindings []string `json:"serverBindings"`
} `json:"handlers"`
}
func parseHandlersOutput(r io.Reader) (*HandlersInfo, error) {
var handlersInfo HandlersInfo
codec := json.NewDecoder(r)
err := codec.Decode(&handlersInfo)
return &handlersInfo, err
}
func probeHandler(service *vespa.Service, cli *CLI) (res util.OperationResult) {
urlPath := service.BaseURL + "/"
url, urlParseError := url.Parse(urlPath)
if urlParseError != nil {
return util.Failure("Invalid request path: '" + urlPath + "': " + urlParseError.Error())
}
request := &http.Request{
URL: url,
Method: "GET",
}
timeout := time.Duration(90) * time.Second
response, err := service.Do(request, timeout)
if err != nil {
return util.Failure("Request failed: " + err.Error())
}
defer response.Body.Close()
if response.StatusCode == 200 {
handlersInfo, err := parseHandlersOutput(response.Body)
if err != nil || len(handlersInfo.Handlers) == 0 {
cli.printWarning("Could not parse JSON response from"+urlPath, err.Error())
return util.Failure("Bad endpoint")
}
for _, h := range handlersInfo.Handlers {
if strings.HasSuffix(h.HandlerClass, "DocumentV1ApiHandler") {
for _, binding := range h.ServerBindings {
if strings.Contains(binding, "/document/v1/") {
return util.Success("handler OK")
}
}
w := fmt.Sprintf("expected /document/v1/ binding, but got: %v", h.ServerBindings)
cli.printWarning(w)
}
}
cli.printWarning("Missing /document/v1/ API; add <document-api /> to the container cluster declaration in services.xml")
return util.Failure("Missing /document/v1 API")
} else {
return util.FailureWithPayload(service.Description()+" at "+request.URL.Host+": "+response.Status, util.ReaderToJSON(response.Body))
}
}
func visitClusters(vArgs *visitArgs, service *vespa.Service) (res util.OperationResult) {
clusters := []string{
vArgs.contentCluster,
}
if vArgs.contentCluster == "*" {
clusters = probeVisit(vArgs, service)
}
if vArgs.makeFeed {
vArgs.writeString("[\n")
}
for _, b := range vArgs.bucketSpaces {
for _, c := range clusters {
vArgs.bucketSpace = b
vArgs.contentCluster = c
res = runVisit(vArgs, service)
if !res.Success {
return res
}
vArgs.debugPrint("Success: " + res.Message)
}
}
if vArgs.makeFeed {
vArgs.writeString("{}\n]\n")
}
return res
}
func probeVisit(vArgs *visitArgs, service *vespa.Service) []string {
clusters := make([]string, 0, 3)
vvo, _ := runOneVisit(vArgs, service, "")
if vvo != nil {
msg := vvo.ErrorMsg
if strings.Contains(msg, "no content cluster '*'") {
for idx, value := range strings.Split(msg, ",") {
if idx > 0 {
parts := strings.Split(value, "'")
if len(parts) == 3 {
clusters = append(clusters, parts[1])
}
}
}
}
}
return clusters
}
func runVisit(vArgs *visitArgs, service *vespa.Service) (res util.OperationResult) {
vArgs.debugPrint(fmt.Sprintf("trying to visit: '%s'", vArgs.contentCluster))
var totalDocuments int = 0
var continuationToken string
for {
var vvo *VespaVisitOutput
vvo, res = runOneVisit(vArgs, service, continuationToken)
if !res.Success {
if vvo != nil && vvo.ErrorMsg != "" {
vArgs.cli.printWarning(vvo.ErrorMsg)
}
return res
}
vArgs.dumpDocuments(vvo.Documents)
vArgs.debugPrint(fmt.Sprintf("got %d documents", len(vvo.Documents)))
totalDocuments += len(vvo.Documents)
continuationToken = vvo.Continuation
if continuationToken == "" {
break
}
}
res.Message = fmt.Sprintf("%s [%d documents visited]", res.Message, totalDocuments)
return
}
func quoteArgForUrl(arg string) string {
var buf strings.Builder
buf.Grow(len(arg))
for _, r := range arg {
switch {
case 'a' <= r && r <= 'z':
buf.WriteRune(r)
case 'A' <= r && r <= 'Z':
buf.WriteRune(r)
case '0' <= r && r <= '9':
buf.WriteRune(r)
case r <= ' ' || r > '~':
buf.WriteRune('+')
default:
s := fmt.Sprintf("%s%02X", "%", r)
buf.WriteString(s)
}
}
return buf.String()
}
func runOneVisit(vArgs *visitArgs, service *vespa.Service, contToken string) (*VespaVisitOutput, util.OperationResult) {
urlPath := service.BaseURL + "/document/v1/?cluster=" + quoteArgForUrl(vArgs.contentCluster)
if vArgs.fieldSet != "" {
urlPath = urlPath + "&fieldSet=" + quoteArgForUrl(vArgs.fieldSet)
}
if vArgs.selection != "" {
urlPath = urlPath + "&selection=" + quoteArgForUrl(vArgs.selection)
}
if contToken != "" {
urlPath = urlPath + "&continuation=" + contToken
}
if vArgs.chunkCount > 0 {
urlPath = urlPath + fmt.Sprintf("&wantedDocumentCount=%d", vArgs.chunkCount)
}
if vArgs.from != "" {
fromSeconds, _ := getEpoch(vArgs.from)
urlPath = urlPath + fmt.Sprintf("&fromTimestamp=%d", fromSeconds*1000000)
}
if vArgs.to != "" {
toSeconds, _ := getEpoch(vArgs.to)
urlPath = urlPath + fmt.Sprintf("&toTimestamp=%d", toSeconds*1000000)
}
if vArgs.slices > 0 {
urlPath = urlPath + fmt.Sprintf("&slices=%d&sliceId=%d", vArgs.slices, vArgs.sliceId)
}
if vArgs.bucketSpace != "" {
urlPath = urlPath + "&bucketSpace=" + vArgs.bucketSpace
}
url, urlParseError := url.Parse(urlPath)
if urlParseError != nil {
return nil, util.Failure("Invalid request path: '" + urlPath + "': " + urlParseError.Error())
}
request := &http.Request{
URL: url,
Method: "GET",
}
timeout := time.Duration(900) * time.Second
response, err := service.Do(request, timeout)
if err != nil {
return nil, util.Failure("Request failed: " + err.Error())
}
defer response.Body.Close()
vvo, err := parseVisitOutput(response.Body)
if response.StatusCode == 200 {
if err == nil {
totalDocCount += vvo.DocumentCount
if vvo.DocumentCount != len(vvo.Documents) {
vArgs.cli.printWarning(fmt.Sprintf("Inconsistent contents from: %v", url))
vArgs.cli.printWarning(fmt.Sprintf("claimed count: %d", vvo.DocumentCount))
vArgs.cli.printWarning(fmt.Sprintf("document blobs: %d", len(vvo.Documents)))
return nil, util.Failure("Inconsistent contents from document API")
}
return vvo, util.Success("visited " + vArgs.contentCluster)
} else {
return nil, util.Failure("error reading response: " + err.Error())
}
} else if response.StatusCode/100 == 4 {
return vvo, util.FailureWithPayload("Invalid document operation: "+response.Status, util.ReaderToJSON(response.Body))
} else {
return vvo, util.FailureWithPayload(service.Description()+" at "+request.URL.Host+": "+response.Status, util.ReaderToJSON(response.Body))
}
}
type DocumentBlob struct {
blob []byte
}
func (d *DocumentBlob) UnmarshalJSON(data []byte) error {
d.blob = make([]byte, len(data))
copy(d.blob, data)
return nil
}
func (d *DocumentBlob) MarshalJSON() ([]byte, error) {
return d.blob, nil
}
type VespaVisitOutput struct {
PathId string `json:"pathId"`
Documents []DocumentBlob `json:"documents"`
DocumentCount int `json:"documentCount"`
Continuation string `json:"continuation"`
ErrorMsg string `json:"message"`
}
func parseVisitOutput(r io.Reader) (*VespaVisitOutput, error) {
codec := json.NewDecoder(r)
var parsedJson VespaVisitOutput
err := codec.Decode(&parsedJson)
if err != nil {
return nil, fmt.Errorf("could not decode JSON, error: %s", err.Error())
}
return &parsedJson, nil
}
|