d56676c9b3
I ran this PR against its main merge-base twice (on my 2021 Mac M1 pro), and in both cases this PR was slightly faster, using the benchmark invocation from [^1]. 2819.6 vs 2808.4 2873.1 vs 2835 Full output below. ---- Script: ``` killall etcd rm -rf default.etcd scripts/build.sh nohup ./bin/etcd --quota-backend-bytes=4300000000 & sleep 10 f=bench-$(git log -1 --pretty=%s | sed -E 's/[^A-Za-z0-9]+/_/g').txt go run ./tools/benchmark txn-put --endpoints="http://127.0.0.1:2379" --clients=200 --conns=200 --key-space-size=4000000000 --key-size=128 --val-size=10240 --total=200000 --rate=40000 | tee "${f}" ``` PR: ``` Summary: Total: 70.9320 secs. Slowest: 0.3003 secs. Fastest: 0.0044 secs. Average: 0.0707 secs. Stddev: 0.0437 secs. Requests/sec: 2819.6030 (second run: 2873.0935) Response time histogram: 0.0044 [1] | 0.0340 [2877] | 0.0636 [119485] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎ 0.0932 [17436] |∎∎∎∎∎ 0.1228 [27364] |∎∎∎∎∎∎∎∎∎ 0.1524 [20349] |∎∎∎∎∎∎ 0.1820 [10214] |∎∎∎ 0.2116 [1248] | 0.2412 [564] | 0.2707 [318] | 0.3003 [144] | Latency distribution: 10% in 0.0368 secs. 25% in 0.0381 secs. 50% in 0.0416 secs. 75% in 0.0998 secs. 90% in 0.1375 secs. 95% in 0.1571 secs. 99% in 0.1850 secs. 99.9% in 0.2650 secs. ``` main: ``` Summary: Total: 71.2152 secs. Slowest: 0.6926 secs. Fastest: 0.0040 secs. Average: 0.0710 secs. Stddev: 0.0461 secs. Requests/sec: 2808.3903 (second run: 2834.98) Response time histogram: 0.0040 [1] | 0.0728 [125816] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎ 0.1417 [59127] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎ 0.2105 [13476] |∎∎∎∎ 0.2794 [1125] | 0.3483 [137] | 0.4171 [93] | 0.4860 [193] | 0.5549 [4] | 0.6237 [16] | 0.6926 [12] | Latency distribution: 10% in 0.0367 secs. 25% in 0.0379 secs. 50% in 0.0417 secs. 75% in 0.0993 secs. 90% in 0.1367 secs. 95% in 0.1567 secs. 99% in 0.1957 secs. 99.9% in 0.4361 secs. ``` [^1]: https://github.com/etcd-io/etcd/pull/14394#issuecomment-1229606410 Signed-off-by: Tobias Grieger <tobias.b.grieger@gmail.com>
etcd
Note: The main branch may be in an unstable or even broken state during development. For stable versions, see releases.
etcd is a distributed reliable key-value store for the most critical data of a distributed system, with a focus on being:
- Simple: well-defined, user-facing API (gRPC)
- Secure: automatic TLS with optional client cert authentication
- Fast: benchmarked 10,000 writes/sec
- Reliable: properly distributed using Raft
etcd is written in Go and uses the Raft consensus algorithm to manage a highly-available replicated log.
etcd is used in production by many companies, and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as Kubernetes, locksmith, vulcand, Doorman, and many others. Reliability is further ensured by rigorous testing.
See etcdctl for a simple command line client.
Maintainers
MAINTAINERS strive to shape an inclusive open source project culture where users are heard and contributors feel respected and empowered. MAINTAINERS maintain productive relationships across different companies and disciplines. Read more about MAINTAINERS role and responsibilities.
Getting started
Getting etcd
The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker on the release page.
For more installation guides, please check out play.etcd.io and operating etcd.
Running etcd
First start a single-member cluster of etcd.
If etcd is installed using the pre-built release binaries, run it from the installation location as below:
/tmp/etcd-download-test/etcd
The etcd command can be simply run as such if it is moved to the system path as below:
mv /tmp/etcd-download-test/etcd /usr/local/bin/
etcd
This will bring up etcd listening on port 2379 for client communication and on port 2380 for server-to-server communication.
Next, let's set a single key, and then retrieve it:
etcdctl put mykey "this is awesome"
etcdctl get mykey
etcd is now running and serving client requests. For more, please check out:
etcd TCP ports
The official etcd ports are 2379 for client requests, and 2380 for peer communication.
Running a local etcd cluster
First install goreman, which manages Procfile-based applications.
Our Procfile script will set up a local example cluster. Start it with:
goreman start
This will bring up 3 etcd members infra1, infra2 and infra3 and optionally etcd grpc-proxy, which runs locally and composes a cluster.
Every cluster member and proxy accepts key value reads and key value writes.
Follow the steps in Procfile.learner to add a learner node to the cluster. Start the learner node with:
goreman -f ./Procfile.learner start
Install etcd client v3
go get go.etcd.io/etcd/client/v3
Next steps
Now it's time to dig into the full etcd API and other guides.
- Read the full documentation.
- Explore the full gRPC API.
- Set up a multi-machine cluster.
- Learn the config format, env variables and flags.
- Find language bindings and tools.
- Use TLS to secure an etcd cluster.
- Tune etcd.
Contact
- Email: etcd-dev
- Slack: #etcd channel on Kubernetes (get an invite)
- Community meetings
Community meetings
etcd contributors and maintainers have monthly (every four weeks) meetings at 11:00 AM (USA Pacific) on Thursday.
An initial agenda will be posted to the shared Google docs a day before each meeting, and everyone is welcome to suggest additional topics or other agendas.
Meeting recordings are uploaded to official etcd YouTube channel.
Get calendar invitation by joining etcd-dev mailing group.
Join Hangouts Meet: meet.google.com/umg-nrxn-qvs
Join by phone: +1 405-792-0633 PIN: 299 906#
Contributing
See CONTRIBUTING for details on submitting patches and the contribution workflow.
Reporting bugs
See reporting bugs for details about reporting any issues.
Reporting a security vulnerability
See security disclosure and release process for details on how to report a security vulnerability and how the etcd team manages it.
Issue and PR management
See issue triage guidelines for details on how issues are managed.
See PR management for guidelines on how pull requests are managed.
etcd Emeritus Maintainers
These emeritus maintainers dedicated a part of their career to etcd and reviewed code, triaged bugs and pushed the project forward over a substantial period of time. Their contribution is greatly appreciated.
- Fanmin Shi
- Anthony Romano
- Brandon Philips
- Joe Betz
- Gyuho Lee
- Jingyi Hu
- Wenjia Zhang
- Xiang Li
- Ben Darnell
- Tobias Grieger
License
etcd is under the Apache 2.0 license. See the LICENSE file for details.