Skip to content

[etcd] Refactor README#9286

Merged
gpop63 merged 6 commits intoelastic:mainfrom
gpop63:fix_etcd_docs_format
Apr 10, 2024
Merged

[etcd] Refactor README#9286
gpop63 merged 6 commits intoelastic:mainfrom
gpop63:fix_etcd_docs_format

Conversation

@gpop63
Copy link
Copy Markdown
Contributor

@gpop63 gpop63 commented Mar 6, 2024

Overview

Refactor etcd README file to use proper documentation guidelines.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@gpop63 gpop63 self-assigned this Mar 6, 2024
@gpop63 gpop63 marked this pull request as ready for review March 6, 2024 21:58
@gpop63 gpop63 requested a review from a team as a code owner March 6, 2024 21:58
@gpop63 gpop63 requested a review from agithomas March 6, 2024 21:58

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I could not find any details regarding --enable-v2. Can you point it to the relevant product documentation?

  2. I see here , the option of using ETCDCTL_API. Can you mention this additionally?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could not find any details regarding --enable-v2. Can you point it to the relevant product documentation?

  • ETCDCTL_API=2 tells the etcdctl client tool to use the v2 API for its commands. It's a client-side configuration when using etcdctl CLI tool.
  • --enable-v2 is a server-side flag that enables or disables the v2 APIs (/v2/stats/self etc) 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, it would be good to highlight the various v2 endpoints

/v2/stats/leader, /v2/stats/self, /v2/stats/store

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@agithomas agithomas requested a review from alaudazzi March 7, 2024 04:13
gpop63 and others added 2 commits March 7, 2024 15:37
Co-authored-by: Agi K Thomas <101976829+agithomas@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@agithomas agithomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestion added.

@agithomas
Copy link
Copy Markdown
Contributor

@alaudazzi , can you please review from your end as well?

@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

History

cc @gpop63

@elastic-sonarqube
Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No Coverage information No data about Coverage
No Duplication information No data about Duplication

See analysis details on SonarQube

Copy link
Copy Markdown
Member

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@agithomas agithomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gpop63 gpop63 merged commit 590a944 into elastic:main Apr 10, 2024
@elasticmachine
Copy link
Copy Markdown

Package etcd - 1.0.1 containing this change is available at https://epr.elastic.co/search?package=etcd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[etcd] Apply the Integrations doc template to etcd

4 participants