Skip to content

Add etcd package#2167

Merged
mtojek merged 17 commits intoelastic:masterfrom
gpop63:master
Dec 7, 2021
Merged

Add etcd package#2167
mtojek merged 17 commits intoelastic:masterfrom
gpop63:master

Conversation

@gpop63
Copy link
Copy Markdown
Contributor

@gpop63 gpop63 commented Nov 17, 2021

What does this PR do?

Adds etcd metricset.
Needs a dashboard.

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.
  • If I'm introducing a new feature, I have modified the Kibana version constraint in my package's manifest.yml file to point to the latest Elastic stack release (e.g. ^7.13.0).

How to test this PR locally

@cla-checker-service
Copy link
Copy Markdown

cla-checker-service bot commented Nov 17, 2021

💚 CLA has been signed

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Nov 17, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-12-07T14:31:12.399+0000

  • Duration: 14 min 8 sec

  • Commit: 6d4a342

Test stats 🧪

Test Results
Failed 0
Passed 11
Skipped 0
Total 11

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@mtojek
Copy link
Copy Markdown
Contributor

mtojek commented Nov 17, 2021

/test

2 similar comments
@mtojek
Copy link
Copy Markdown
Contributor

mtojek commented Nov 17, 2021

/test

@mtojek
Copy link
Copy Markdown
Contributor

mtojek commented Nov 18, 2021

/test

@masci masci requested a review from sayden November 19, 2021 09:58
@masci masci linked an issue Nov 19, 2021 that may be closed by this pull request
19 tasks
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.

This description is wrong. The package description should be extracted from this file https://github.com/elastic/beats/blob/master/metricbeat/module/etcd/_meta/docs.asciidoc and then each metricset will have its own [metricset]/_meta/docs.asciidoc file to extract the info for this file from.

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.

Insert the sample event in this doc too. Look at an example of how to do it here: https://raw.githubusercontent.com/elastic/integrations/master/packages/kibana/_dev/build/docs/README.md

Basically you need to use {{event [metricset]}} or {{fields [metricset]}}

Copy link
Copy Markdown
Contributor

@sayden sayden left a comment

Choose a reason for hiding this comment

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

Left some comments but it's almost finished

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.

This should now be "^7.15.1" || ^8.0.0"

@mtojek mtojek requested a review from sayden November 23, 2021 08:48
@mtojek
Copy link
Copy Markdown
Contributor

mtojek commented Nov 23, 2021

/test

1 similar comment
@mtojek
Copy link
Copy Markdown
Contributor

mtojek commented Nov 25, 2021

/test

@mtojek mtojek marked this pull request as ready for review November 25, 2021 12:53
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.

nit: you can remove the comment

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'm wondering if you need to build the Docker image if you're using the default bitnami/etcd. Did you try to go without Dockerfile?

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.

nit: capital letter (Successful)

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.

nit: capital letter (Failed)

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.

If you have to be consistent with letter-casing: ETCD vs etcd vs Etcd. I think the official name is "etcd". Would you mind double-check the rest of the PR.

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.

This metrics is being read from the Etcd V3 endpoint and won’t show any activity regarding Etcd V2.

I think this information is redundant as you already described it above, before listing data streams. I would recommend to add 1-2 sentences to every data stream and describe what kind of metrics will the data stream proivde.

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.

We don't use "metricsets" anymore. This is a term valid for Beats only. Integrations are using data streams. Please adjust the entire PR accordingly.

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.

Is it possible to follow the snake case? For example: append_request, bandwidth_rate

@gpop63
Copy link
Copy Markdown
Contributor Author

gpop63 commented Nov 25, 2021

/test

@mtojek mtojek self-requested a review December 6, 2021 15:23
Copy link
Copy Markdown
Contributor

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

Once this PR is merged, do you plan to work on dashboards?

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.

Let's not release it as "GA", but "experimental" or "beta".

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.

Yes, I can work on dashboards.

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.

Could you please try also against other versions?

@gpop63 gpop63 requested a review from mtojek December 7, 2021 13:12
Copy link
Copy Markdown
Contributor

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

I re-reviewed the PR and it looks correct. I left one comment regarding definitions of services for tests.

@mtojek mtojek self-requested a review December 7, 2021 14:46
@mtojek mtojek merged commit 871cc9f into elastic:master Dec 7, 2021
@andrewkroh andrewkroh added the New Integration Issue or pull request for creating a new integration package. label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Integration:etcd etcd New Integration Issue or pull request for creating a new integration package.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Etcd package

6 participants