bft blockchain consensus consistency cryptocurrency cryptography db distributed-systems go

History

William Banfield 7bf7ff6639 internal/proxy: add initial set of abci metrics backport (#7342 ) * internal/proxy: add initial set of abci metrics (#7115) This PR adds an initial set of metrics for use ABCI. The initial metrics enable the calculation of timing histograms and call counts for each of the ABCI methods. The metrics are also labeled as either 'sync' or 'async' to determine if the method call was performed using ABCI's `Async` methods. An example of these metrics is included here for reference: ``` tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.0001"} 0 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.0004"} 5 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.002"} 12 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.009"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.02"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.1"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="0.65"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="2"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="6"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="25"} 13 tendermint_abci_connection_method_timing_bucket{chain_id="ci",method="commit",type="sync",le="+Inf"} 13 tendermint_abci_connection_method_timing_sum{chain_id="ci",method="commit",type="sync"} 0.007802058000000001 tendermint_abci_connection_method_timing_count{chain_id="ci",method="commit",type="sync"} 13 ``` These metrics can easily be graphed using prometheus's `histogram_quantile(...)` method to pick out a particular quantile to graph or examine. I chose buckets that were somewhat of an estimate of expected range of times for ABCI operations. They start at .0001 seconds and range to 25 seconds. The hope is that this range captures enough possible times to be useful for us and operators. lint++ * docs: add abci timing metrics to the metrics docs (#7311) * cherry-pick fixup		3 years ago
..
.vuepress	Add v0.35 to the configs for building the docs website. (#7055) (#7278)	3 years ago
app-dev	doc: fix a typo in the indexing section (#6909)	3 years ago
architecture	Update the psql indexer schema and implementation (#6868)	3 years ago
imgs	ADR 047 - Light client evidence handling revision (#5273)	4 years ago
introduction	docs: rename tendermint-core to system (#6515)	4 years ago
networks	config/docs: update and deprecated (#6879)	3 years ago
nodes	internal/proxy: add initial set of abci metrics backport (#7342)	3 years ago
rfc	rfc: event system (#6957)	3 years ago
roadmap	docs: fix broken links and layout (#7154) (#7163)	3 years ago
security	docs: hide security page (second attempt) (#6511)	4 years ago
tendermint-core	docs: fix broken links and layout (#7154) (#7163)	3 years ago
tools	docs: fix broken links and layout (#7154) (#7163)	3 years ago
tutorials	docs: go tutorial fixed for 0.35.0 version (#7329) (#7330) (#7331)	3 years ago
.textlintrc.json	lint markdown docs using a stop-words and write-good linters (#2195)	6 years ago
DOCS_README.md	Make doc site index default to the latest release (#7023)	3 years ago
README.md	docs: update .vuepress/config.js (#5043)	5 years ago
package-lock.json	docs: fix broken links and layout (#7154) (#7163)	3 years ago
package.json	build(deps-dev): Bump watchpack from 2.1.1 to 2.2.0 in /docs (#6482)	4 years ago
post.sh	Docs theme latest (#4179)	5 years ago
pre.sh	docs: rename swagger to openapi (#5263)	4 years ago
stop-words.txt	lint markdown docs using a stop-words and write-good linters (#2195)	6 years ago
tendermint-core-image.jpg	docs: add readme image (#3763)	6 years ago
versions	Add v0.35 to the configs for building the docs website. (#7055) (#7278)	3 years ago

README.md

title	description	footer
Tendermint Core Documentation	Tendermint Core is a blockchain application platform.	[{newsletter false}]

Tendermint

Welcome to the Tendermint Core documentation!

Tendermint Core is a blockchain application platform; it provides the equivalent of a web-server, database, and supporting libraries for blockchain applications written in any programming language. Like a web-server serving web applications, Tendermint serves blockchain applications.

More formally, Tendermint Core performs Byzantine Fault Tolerant (BFT) State Machine Replication (SMR) for arbitrary deterministic, finite state machines. For more background, see What is Tendermint?.

To get started quickly with an example application, see the quick start guide.

To learn about application development on Tendermint, see the Application Blockchain Interface.

For more details on using Tendermint, see the respective documentation for Tendermint Core, benchmarking and monitoring, and network deployments.

To find out about the Tendermint ecosystem you can go here. If you are a project that is using Tendermint you are welcome to make a PR to add your project to the list.

Contribute

To contribute to the documentation, see this file for details of the build process and considerations when making changes.