Heartbeat Automatic Reloading Docs #8227
Conversation
heartbeat/monitors/pluginconf.go
Outdated
| return fmt.Sprintf("Monitor not loaded, plugin is disabled") | ||
| } | ||
|
|
||
| type MonitorPluginInfo struct { |
There was a problem hiding this comment.
exported type MonitorPluginInfo should have comment or be unexported
heartbeat/monitors/pluginconf.go
Outdated
| "github.com/elastic/beats/libbeat/common" | ||
| ) | ||
|
|
||
| type PluginDisabledError struct{} |
There was a problem hiding this comment.
exported type PluginDisabledError should have comment or be unexported
heartbeat/monitors/monitor.go
Outdated
| } | ||
| } | ||
|
|
||
| func (m *Monitor) Stop() { |
There was a problem hiding this comment.
exported method Monitor.Stop should have comment or be unexported
heartbeat/monitors/monitor.go
Outdated
| return nil | ||
| } | ||
|
|
||
| func (m *Monitor) Start() { |
There was a problem hiding this comment.
exported method Monitor.Start should have comment or be unexported
andrewvc
force-pushed
the
hbreload-docs
branch
from
71a2cfa to
09c4715
Compare
andrewvc
force-pushed
the
hbreload-docs
branch
from
09c4715 to
6e0c1e3
Compare
andrewvc
changed the title
andrewvc
added
review
and removed
in progress
| determine if they are available. Each `monitor` item begins with a dash (-) and | ||
| specifies the type of monitor to use, the hosts to check, and other settings | ||
| that control Heartbeat behavior. | ||
| Heartbeat is configured by defining a set of `monitors` to check your remote hosts. |
There was a problem hiding this comment.
I like that you've changed this section to be more task-focused, but you should avoid passive voice, and speak directly to the user. I'd suggest starting with a description of what a monitor is and then explain how to configure them.
There was a problem hiding this comment.
Just an FYI that we should use asciidoc attributes to resolve product names, so use {beatname_uc} instead of Heartbeat. I try to do this whenever I update topics these days.
| specifies the type of monitor to use, the hosts to check, and other settings | ||
| that control Heartbeat behavior. | ||
| Heartbeat is configured by defining a set of `monitors` to check your remote hosts. | ||
| These can be specified either inside the +heartbeat.yml+ config file, or in external |
There was a problem hiding this comment.
Again, I would avoid passive voice.
There was a problem hiding this comment.
I want to tighten up the language used here, but rather than entering comments on this PR, it'll be more efficient for me to come back later and edit these additions in a separate PR. So for now, I'll just point out stuff that is potentially confusing, rather than style issues. Created an issue here: #8332
|
|
||
| experimental[] | ||
|
|
||
| THIS EXPERIMENTAL FEATURE IS NOW DEPRECATED. IT WILL BE REMOVED IN A FUTURE |
There was a problem hiding this comment.
You should replace the experimental[] tag with deprecated (see https://github.com/elastic/docs#section-notifications). Within the tag itself, you can add details to provide more info about the deprecation.
|
@dedemorton I believe I've addressed the issues you mentioned with beat name references and the passive voice in the last two commits. LMK what you think :) |
Docs for the changes in elastic#8023 for heartbeat automatic reloading. (cherry picked from commit 04597c8)
Docs for the changes in #8023 for heartbeat automatic reloading.