Improve documentation for server metricset in Zookeeper metricbeat module #10692

arsalan0c · 2019-02-12T12:23:19Z

Fields to improve:

elasticmachine · 2019-02-12T12:23:21Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

sayden · 2019-02-12T15:04:58Z

Hi @arsalanc-v2 . An absolutely amazing job. Even I'm learning things of Zookeeper I didn't know with this descriptions.

You still need to sign the CLA, read https://github.com/elastic/beats/blob/master/CONTRIBUTING.md to see how. Also, a change in fields.yml requires an update of the docs a few things more. You can achieve this by running make update from Metricbeat folder.

sayden

make update needs to be run

arsalan0c · 2019-02-13T09:45:46Z

Thank you! I have signed the CLA, please let me know if there is anything else I need to do to make the check pass.

sayden · 2019-02-13T17:31:12Z

Left you some comments, it seems you need a rebase ensure that you aren't adding anything unrelated to the branch. Then make collect && make update

sayden · 2019-02-13T17:30:04Z

CHANGELOG.next.asciidoc

@@ -81,7 +81,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - The `elasticsearch/deprecation` fileset now indexes the `component` field under `elasticsearch` instead of `elasticsearch.server`. {pull}10445[10445]
 - Remove field `kafka.log.trace.full` from kafka.log fielset. {pull}10398[10398]
 - Change field `kafka.log.class` for kafka.log fileset from text to keyword. {pull}10398[10398]
- Address add_kubernetes_metadata processor issue where old source field is 
+- Address add_kubernetes_metadata processor issue where old source field is


This shouldn't go here. It seems some branching conflict. Try to rebase to master again and running make collect && make update

arsalan0c · 2019-02-14T09:05:49Z

When running either make collect or make update, an error appears exactly as the one mentioned here #7489 . However, the solution proposed there (manually creating the virtual environment) still results in the same error. It occurs right after "Generated fields.yml for metricbeat to ..."

It seems like a common problem with other projects but I have not found a solution that would be applicable here

sayden · 2019-02-14T09:50:05Z

Yeah, it's common because our build system is done with Python 2 and it's tricky to make it work if you also have Python 3 installed. Ensure that you have Python 2 installed, of course :)

The workaround there should work, however. Try this way from Metricbeat folder:

VIRTUALENV_PARAMS="-p python2.7" make python-env
source build/python-env/bin/activate
VIRTUALENV_PARAMS="-p python2.7" make collect-docs
VIRTUALENV_PARAMS="-p python2.7" make update

To really force

arsalan0c · 2019-02-14T10:14:49Z

Unfortunately that does not work either.

Is it possible that despite the initial Python 2.7 deprecation message, Python 3 is still being used for subsequent processes? Also, would you recommend I uninstall Python 3?

ruflin · 2019-02-14T12:41:06Z

@arsalanc-v2 It's just a guess but I have seen similar things in the past having both python version and some dependencies for Python 2.7 were taken from Python 3 and that created a mess. Uninstalling Python 3 could definitively help and then remove / install the dependencies again. But not sure if that is a bit too much to ask to change your env.

Seeing you are on OS X, do you use brew? Perhaps you could use pyenv to manage your python versions?

sayden · 2019-02-15T10:14:11Z

Yes, it's definitely using Python 3 in some moment. It has happened to me in the past too.

You probably have a symlink from python command to your python3 binary. You can also try to backup this symlink (I don't know where it is located in OSX but check with whereis python) and then symlink python2 binary to python. I think this is how I solved it

arsalan0c · 2019-02-17T12:59:55Z

@ruflin @sayden Thank you for your help! The commands ran successfully on an ubuntu vm.

Yes I use brew and pyenv seems like a great tool, I'll be using it from now on.

sayden · 2019-02-18T10:32:50Z

@arsalanc-v2 don't forget that you need to sign the CLA https://www.elastic.co/contributor-agreement/

The PR looks done or almost done. Let's see what Jenkins thinks :)

sayden

Jenkins is happy. So we are just waiting you to sign the CLA and we are good to go

arsalan0c · 2019-02-18T13:27:27Z

Awesome, I enjoyed working on this. I signed the CLA on 12/02/2019 and received the pdf by email. Is there anything else I need to do to make the check pass?

jsoriano · 2019-02-20T09:56:04Z

@arsalanc-v2 please check if you signed the CLA with the same email address as the used for your commits, you can see in https://github.com/elastic/beats/pull/10692.patch the email in the commits.

arsalan0c · 2019-02-21T13:47:35Z

@jsoriano The same email was used but the name was different. I've resolved that and the patch file shows the correct name now (:

sayden · 2019-02-21T13:48:54Z

jenkins, test this please

jsoriano · 2019-02-26T09:48:50Z

@arsalanc-v2 sorry, there was some issue with CLA signing last week, could you try to sign it again? 🤞

arsalan0c · 2019-02-26T11:44:47Z

@jsoriano Done!

sayden · 2019-02-26T12:07:45Z

Awesome @arsalanc-v2 Let's wait CI to go green before merging :)

sayden · 2019-02-27T09:55:16Z

Oh, @arsalanc-v2 I didn't realize until now. Forgive me but we don't add CHANGELOG entries to docs updates. Can you remove it so we can merge the PR 🙂 ?

houndci-bot · 2019-02-28T01:19:35Z

libbeat/mock/mockbeat.go

@@ -30,6 +31,8 @@ import (
 var Version = "9.9.9"
 var Name = "mockbeat"

+var Settings = instance.Settings{Name: Name, Version: Version}


exported var Settings should have comment or be unexported

houndci-bot · 2019-02-28T01:19:36Z

libbeat/libbeat.go

@@ -24,7 +24,7 @@ import (
 	"github.com/elastic/beats/libbeat/mock"
 )

-var RootCmd = cmd.GenRootCmd(mock.Name, mock.Version, mock.New)
+var RootCmd = cmd.GenRootCmdWithSettings(mock.New, mock.Settings)


exported var RootCmd should have comment or be unexported

houndci-bot · 2019-02-28T01:19:36Z

libbeat/cmd/test/output.go

@@ -29,18 +29,18 @@ import (
 	"github.com/elastic/beats/libbeat/testing"
 )

-func GenTestOutputCmd(name, beatVersion string) *cobra.Command {
+func GenTestOutputCmd(settings instance.Settings) *cobra.Command {


exported function GenTestOutputCmd should have comment or be unexported

houndci-bot · 2019-02-28T01:19:36Z

libbeat/cmd/test/config.go

@@ -27,18 +27,18 @@ import (
 	"github.com/elastic/beats/libbeat/cmd/instance"
 )

-func GenTestConfigCmd(name, version string, beatCreator beat.Creator) *cobra.Command {
+func GenTestConfigCmd(settings instance.Settings, beatCreator beat.Creator) *cobra.Command {


exported function GenTestConfigCmd should have comment or be unexported

houndci-bot · 2019-02-28T01:19:36Z

libbeat/cmd/export/template.go

@@ -31,7 +31,7 @@ import (
 	"github.com/elastic/beats/libbeat/template"
 )

-func GenTemplateConfigCmd(settings instance.Settings, name, idxPrefix, beatVersion string) *cobra.Command {
+func GenTemplateConfigCmd(settings instance.Settings) *cobra.Command {


exported function GenTemplateConfigCmd should have comment or be unexported

houndci-bot · 2019-02-28T01:19:36Z

filebeat/input/log/stdin.go

@@ -44,3 +44,4 @@ func (p Pipe) Name() string               { return p.File.Name() }
 func (p Pipe) Stat() (os.FileInfo, error) { return p.File.Stat() }
 func (p Pipe) Continuable() bool          { return false }
 func (p Pipe) HasState() bool             { return false }
+func (p Pipe) Removed() bool              { return false }


exported method Pipe.Removed should have comment or be unexported

houndci-bot · 2019-02-28T01:19:37Z

filebeat/input/log/file.go


 type File struct {
 	*os.File
 }

 func (File) Continuable() bool { return true }
 func (File) HasState() bool    { return true }
+func (f File) Removed() bool   { return file.IsRemoved(f.File) }


exported method File.Removed should have comment or be unexported

arsalan0c · 2019-02-28T01:41:32Z

@sayden Ah I see, no worries I've removed it. I read that from the contributing guide

arsalan0c · 2019-02-28T01:52:44Z

Also, I mistakenly pushed some old code (resolved now)

sayden · 2019-02-28T11:54:05Z

jenkins, test this

sayden · 2019-03-01T11:31:37Z

Good work @arsalanc-v2 👍

ruflin · 2019-03-04T09:23:38Z

@sayden Should we backport this?

arsalan0c requested a review from a team as a code owner February 12, 2019 12:23

ruflin requested a review from sayden February 12, 2019 15:00

ruflin added module review Metricbeat Metricbeat Team:Integrations Label for the Integrations team labels Feb 12, 2019

sayden suggested changes Feb 12, 2019

View reviewed changes

arsalan0c requested a review from a team as a code owner February 13, 2019 09:08

arsalan0c force-pushed the improve_docs branch 3 times, most recently from 121d372 to 7a4d48f Compare February 13, 2019 09:41

sayden suggested changes Feb 13, 2019

View reviewed changes

arsalan0c force-pushed the improve_docs branch 2 times, most recently from 80fefee to bcfc44e Compare February 14, 2019 06:48

arsalan0c force-pushed the improve_docs branch from bab6d1a to 4d30ecc Compare February 17, 2019 13:02

sayden reviewed Feb 18, 2019

View reviewed changes

arsalan0c force-pushed the improve_docs branch from 3976135 to ba48ca3 Compare February 20, 2019 10:43

arsalan0c force-pushed the improve_docs branch 5 times, most recently from e4a831f to 4f13e58 Compare February 21, 2019 13:39

arsalan0c force-pushed the improve_docs branch from c218962 to ad3c3e1 Compare February 28, 2019 01:19

arsalan0c requested review from a team as code owners February 28, 2019 01:19

houndci-bot reviewed Feb 28, 2019

View reviewed changes

add documentation changes from running make collect-docs and make update

ee67a3d

arsalan0c force-pushed the improve_docs branch from ad3c3e1 to ee67a3d Compare February 28, 2019 01:37

sayden removed request for a team February 28, 2019 11:53

cachedout approved these changes Feb 28, 2019

View reviewed changes

sayden approved these changes Mar 1, 2019

View reviewed changes

sayden merged commit 90f1f1a into elastic:master Mar 1, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation for server metricset in Zookeeper metricbeat module #10692

Improve documentation for server metricset in Zookeeper metricbeat module #10692

arsalan0c commented Feb 12, 2019 •

edited

Loading

elasticmachine commented Feb 12, 2019

sayden commented Feb 12, 2019

sayden left a comment

arsalan0c commented Feb 13, 2019

sayden commented Feb 13, 2019

sayden Feb 13, 2019

arsalan0c commented Feb 14, 2019

sayden commented Feb 14, 2019 •

edited

Loading

arsalan0c commented Feb 14, 2019

ruflin commented Feb 14, 2019

sayden commented Feb 15, 2019 •

edited

Loading

arsalan0c commented Feb 17, 2019

sayden commented Feb 18, 2019

sayden left a comment

arsalan0c commented Feb 18, 2019 •

edited

Loading

jsoriano commented Feb 20, 2019

arsalan0c commented Feb 21, 2019 •

edited

Loading

sayden commented Feb 21, 2019

jsoriano commented Feb 26, 2019

arsalan0c commented Feb 26, 2019 •

edited

Loading

sayden commented Feb 26, 2019

sayden commented Feb 27, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

houndci-bot Feb 28, 2019

arsalan0c commented Feb 28, 2019

arsalan0c commented Feb 28, 2019

sayden commented Feb 28, 2019

sayden commented Mar 1, 2019

ruflin commented Mar 4, 2019

Improve documentation for server metricset in Zookeeper metricbeat module #10692

Improve documentation for server metricset in Zookeeper metricbeat module #10692

Conversation

arsalan0c commented Feb 12, 2019 • edited Loading

elasticmachine commented Feb 12, 2019

sayden commented Feb 12, 2019

sayden left a comment

Choose a reason for hiding this comment

arsalan0c commented Feb 13, 2019

sayden commented Feb 13, 2019

Choose a reason for hiding this comment

arsalan0c commented Feb 14, 2019

sayden commented Feb 14, 2019 • edited Loading

arsalan0c commented Feb 14, 2019

ruflin commented Feb 14, 2019

sayden commented Feb 15, 2019 • edited Loading

arsalan0c commented Feb 17, 2019

sayden commented Feb 18, 2019

sayden left a comment

Choose a reason for hiding this comment

arsalan0c commented Feb 18, 2019 • edited Loading

jsoriano commented Feb 20, 2019

arsalan0c commented Feb 21, 2019 • edited Loading

sayden commented Feb 21, 2019

jsoriano commented Feb 26, 2019

arsalan0c commented Feb 26, 2019 • edited Loading

sayden commented Feb 26, 2019

sayden commented Feb 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arsalan0c commented Feb 28, 2019

arsalan0c commented Feb 28, 2019

sayden commented Feb 28, 2019

sayden commented Mar 1, 2019

ruflin commented Mar 4, 2019

arsalan0c commented Feb 12, 2019 •

edited

Loading

sayden commented Feb 14, 2019 •

edited

Loading

sayden commented Feb 15, 2019 •

edited

Loading

arsalan0c commented Feb 18, 2019 •

edited

Loading

arsalan0c commented Feb 21, 2019 •

edited

Loading

arsalan0c commented Feb 26, 2019 •

edited

Loading