Conversation
|
|
||
| When using v3, datasets are bundled within `metrics` data stream, while for v2, available datasets include `leader`, `self`, and `store`. | ||
|
|
||
| The etcd v2 APIs are not enabled by default. However, you can enable etcd v2 APIs when using etcd v3 and above by utilizing the --enable-v2 flag, provided it is supported. |
There was a problem hiding this comment.
-
I could not find any details regarding
--enable-v2. Can you point it to the relevant product documentation? -
I see here , the option of using
ETCDCTL_API. Can you mention this additionally?
There was a problem hiding this comment.
I could not find any details regarding --enable-v2. Can you point it to the relevant product documentation?
ETCDCTL_API=2tells theetcdctlclient tool to use the v2 API for its commands. It's a client-side configuration when usingetcdctlCLI tool.--enable-v2is a server-side flag that enables or disables the v2 APIs (/v2/stats/selfetc) on the etcd server itself.
--enable-v2 'false'
Accept etcd V2 client requests. Deprecated and to be decommissioned in v3.6.
https://etcd.io/docs/v3.5/op-guide/configuration/#clustering
From 3.6 I think they might remove this flag.
| ## Requirements | ||
|
|
||
| For etcd v2, metrics are collected through the etcd v2 APIs, whereas for v3, they are fetched from the `/metrics` endpoint. | ||
| In order to ingest data from etcd, you must know the instance host. |
There was a problem hiding this comment.
In other packages, the below mentioned content is commonly added
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your hardware.
There was a problem hiding this comment.
Kindly mention the availability of individual endpoints /v2/stats/leader, /v2/stats/self, /v2/stats/store, /metrics for the working of related datastream
|
|
||
| ## Data streams | ||
|
|
||
| For etcd v2, metrics are collected through the etcd v2 APIs, whereas for v3, they are fetched from the `/metrics` endpoint. |
There was a problem hiding this comment.
I think, it would be good to highlight the various v2 endpoints
/v2/stats/leader, /v2/stats/self, /v2/stats/store
There was a problem hiding this comment.
The link mentioned here points to version 3.1. In the compatibility, the version mentioned is 3.5. So suggest using https://etcd.io/docs/v3.5/op-guide/monitoring/ this link instead.
Co-authored-by: Agi K Thomas <101976829+agithomas@users.noreply.github.com>
agithomas
left a comment
There was a problem hiding this comment.
Minor suggestion added.
|
@alaudazzi , can you please review from your end as well? |
💚 Build Succeeded
History
cc @gpop63 |
|
|
Package etcd - 1.0.1 containing this change is available at https://epr.elastic.co/search?package=etcd |



Overview
Refactor etcd README file to use proper documentation guidelines.
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots