Skip to content
This repository was archived by the owner on Sep 14, 2023. It is now read-only.

Commit e65ee7e

Browse files
committed
Edits to content about FlagsHandler
1 parent a484eb9 commit e65ee7e

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/newbeat.asciidoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ and sends it to the publisher
120120
The `Beat` parameter received by most of these methods contains data about the
121121
Beat, such as the name, version, and common configuration options.
122122

123-
For more complex beats, the optional FlagsHandler interface is available.
123+
For more complex Beats, the optional `FlagsHandler` interface is available.
124124

125125
[source,go]
126126
----------------------------------------------------------------------
@@ -129,17 +129,18 @@ type FlagsHandler interface {
129129
}
130130
----------------------------------------------------------------------
131131

132-
The FlagsHandler Beater extension is for handling flags input on startup.
133-
The HandleFlags callback will be called after parsing the command line
134-
arguments and handling the '--help' or '--version' flags. Use this interface
135-
to add additional command line flags to your beat. For an example on how to
136-
implement HandleFlags, have a look at
137-
https://github.com/elastic/packetbeat/blob/master/beat/packetbeat.go[packetbeat]
132+
You can use the `FlagsHandler` interface to add additional command line flags to
133+
your Beat. The `HandleFlags` callback is called after the Beat parses the
134+
command line arguments inherited from libbeat and handles the `--help` and
135+
`--version` flags. For an example of how to implement `HandleFlags`, take a look
136+
at the
137+
https://github.com/elastic/packetbeat/blob/master/beat/packetbeat.go[Packetbeat]
138+
code.
138139

139-
We strongly recommend to only put the main method into the main package.
140-
This will allow all other parts of your beat to be used as library by
141-
other beats if needed. This means all your beat specific code goes for example
142-
into the beat folder and package.
140+
We strongly recommend that you create a main package that contains only the main
141+
method. All your Beat-specific code should go in a separate folder and package.
142+
This will allow other Beats to use the other parts of your Beat as a library, if
143+
needed.
143144

144145
NOTE: To be consistent with other Beats, you should append `beat` to your Beat name.
145146

@@ -342,7 +343,7 @@ func main() {
342343
}
343344
----------------------------------------------------------------------
344345

345-
We recommend to implement a New function that creates your beats object.
346+
We recommend that you implement a `New` function that creates your Beats object.
346347

347348
=== Sharing Your Beat with the Community
348349

0 commit comments

Comments
 (0)