commit | e55b1e7b0d97fce3066a9d553e5a3b8567f47770 | [log] [tgz] |
---|---|---|
author | Keegan Carruthers-Smith <keegan.csmith@gmail.com> | Wed Mar 18 13:08:05 2020 +0200 |
committer | Keegan Carruthers-Smith <keegan.csmith@gmail.com> | Fri Mar 20 08:31:41 2020 +0200 |
tree | 7b0eac14183733c776a0d1f4bb7b9237546b52db | |
parent | 8a492e33f4d5de9778a94ae741e4a14aa5a71004 [diff] |
shards: prometheus metrics for sharded search We add several metrics and add the prometheus http handler to zoekt-webserver if pprof is enabled. - Gauges for number of running searches and lists. - Gauges for number of searches and lists within a shard. - Histogram for search duration. - Counter for number of search failures. - A counter per zoekt.Stats The gauge should for searches should help with noticing a queue forming. The gauges in shards should be bounded, but are useful to understand load. The rest of the metrics are pretty straightforward. Change-Id: I24c55204a0e742479f9bae01301cc258289a4101
"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)
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
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.
It is recommended to install Universal ctags to improve ranking. See here for more information.
Thanks to Alexander Neubeck for coming up with this idea, and helping me flesh it out.
This is not an official Google product