Google Git
Sign in
gerrit / zoekt / 031d44576f1fc0d6cfa9214d7e0155b2414d53f8
commit031d44576f1fc0d6cfa9214d7e0155b2414d53f8[log] [tgz]
authorKeegan Carruthers-Smith <keegan.csmith@gmail.com>Tue Feb 23 12:13:03 2021 +0200
committerKeegan Carruthers-Smith <keegan.csmith@gmail.com>Tue Feb 23 13:12:03 2021 +0200
treeb275fd55e72d734d10745d509f42b0f3c2b86c4a
parent217568b78b544d81d789b0ae9b7e7848d6ac5db0 [diff]
shards: wait for watcher to stop when closing

Previously we never shutdown the shardWatcher. This meant that when
closing shardedSearcher, the shardWatcher would still interact with it
if it noticed shards changing. This can happen in practice but is
rare. It can more easily be triggered by running e2e tests which cleanup
the index files.

Change-Id: I372e9f1723485ae092d82f0502deb64b4b3c976f
3 files changed
tree: b275fd55e72d734d10745d509f42b0f3c2b86c4a
  1. build/
  2. cmd/
  3. ctags/
  4. doc/
  5. gitindex/
  6. query/
  7. shards/
  8. web/
  9. .gitignore
  10. all.bash
  11. api.go
  12. bits.go
  13. bits_test.go
  14. build-deploy.sh
  15. contentprovider.go
  16. CONTRIBUTING
  17. eval.go
  18. eval_test.go
  19. go.mod
  20. go.sum
  21. hititer.go
  22. hititer_test.go
  23. index_test.go
  24. indexbuilder.go
  25. indexdata.go
  26. indexfile_other.go
  27. indexfile_unix.go
  28. LICENSE
  29. matchiter.go
  30. matchtree.go
  31. matchtree_test.go
  32. read.go
  33. read_test.go
  34. README.md
  35. section.go
  36. section_test.go
  37. toc.go
  38. write.go
README.md
"Zoekt, en gij zult spinazie eten" - Jan Eertink

("seek, and ye shall eat spinach" - My primary school teacher)

This is a fast text search engine, intended for use with source code. (Pronunciation: roughly as you would pronounce “zooked” in English)

INSTRUCTIONS

Downloading:

go get github.com/google/zoekt/

Indexing:

go install github.com/google/zoekt/cmd/zoekt-index
$GOPATH/bin/zoekt-index .

Searching

go install github.com/google/zoekt/cmd/zoekt
$GOPATH/bin/zoekt 'ngram f:READ'

Indexing git repositories:

go install github.com/google/zoekt/cmd/zoekt-git-index
$GOPATH/bin/zoekt-git-index -branches master,stable-1.4 -prefix origin/ .

Indexing repo repositories:

go install github.com/google/zoekt/cmd/zoekt-{repo-index,mirror-gitiles}
zoekt-mirror-gitiles -dest ~/repos/ https://gfiber.googlesource.com
zoekt-repo-index \
   -name gfiber \
   -base_url https://gfiber.googlesource.com/ \
   -manifest_repo ~/repos/gfiber.googlesource.com/manifests.git \
   -repo_cache ~/repos \
   -manifest_rev_prefix=refs/heads/ --rev_prefix= \
   master:default_unrestricted.xml

Starting the web interface

go install github.com/google/zoekt/cmd/zoekt-webserver
$GOPATH/bin/zoekt-webserver -listen :6070

A more organized installation on a Linux server should use a systemd unit file, eg.

[Unit]
Description=zoekt webserver

[Service]
ExecStart=/zoekt/bin/zoekt-webserver -index /zoekt/index -listen :443  --ssl_cert /zoekt/etc/cert.pem   --ssl_key /zoekt/etc/key.pem
Restart=always

[Install]
WantedBy=default.target

SEARCH SERVICE

Zoekt comes with a small service management program:

go install github.com/google/zoekt/cmd/zoekt-indexserver

cat << EOF > config.json
[{"GithubUser": "username"},
 {"GithubOrg": "org"},
 {"GitilesURL": "https://gerrit.googlesource.com", "Name": "zoekt" }
]
EOF

$GOPATH/bin/zoekt-server -mirror_config config.json

This will mirror all repos under ‘github.com/username’, ‘github.com/org’, as well as the ‘zoekt’ repository. It will index the repositories.

It takes care of fetching and indexing new data and cleaning up logfiles.

The webserver can be started from a standard service management framework, such as systemd.

SYMBOL SEARCH

It is recommended to install Universal ctags to improve ranking. See here for more information.

ACKNOWLEDGEMENTS

Thanks to Alexander Neubeck for coming up with this idea, and helping me flesh it out.

DISCLAIMER

This is not an official Google product