func TestModuleRunner(t *testing.T) {
pubClient, factory := newPubClientFactory()
config, err := common.NewConfigFrom(map[string]interface{}{
"module": moduleName,
"metricsets": []string{metricSetName},
})
if err != nil {
t.Fatal(err)
}
// Create a new ModuleWrapper based on the configuration.
module, err := metricbeat.NewModuleWrapper(config, mb.Registry)
if err != nil {
t.Fatal(err)
}
// Create the ModuleRunner facade.
runner := metricbeat.NewModuleRunner(factory, module)
// Start the module and have it publish to a new publisher.Client.
runner.Start()
assert.NotNil(t, <-pubClient.Channel)
// Stop the module. This blocks until all MetricSets in the Module have
// stopped and the publisher.Client is closed.
runner.Stop()
}
// ExampleModuleRunner demonstrates how to use ModuleRunner to start and stop
// a module.
func ExampleModuleRunner() {
// A *beat.Beat is injected into a Beater when it runs and contains the
// Publisher used to publish events. This Beat pointer is created here only
// for demonstration purposes.
var b *beat.Beat
config, err := common.NewConfigFrom(map[string]interface{}{
"module": moduleName,
"metricsets": []string{metricSetName},
})
if err != nil {
return
}
// Create a new ModuleWrapper based on the configuration.
module, err := metricbeat.NewModuleWrapper(config, mb.Registry)
if err != nil {
return
}
// Create the ModuleRunner facade.
runner := metricbeat.NewModuleRunner(b.Publisher.Connect, module)
// Start the module and have it publish to a new publisher.Client.
runner.Start()
// Stop the module. This blocks until all MetricSets in the Module have
// stopped and the publisher.Client is closed.
runner.Stop()
}
func TestModuleWrapper(t *testing.T) {
hosts := []string{"alpha", "beta"}
c := newConfig(t, map[string]interface{}{
"module": moduleName,
"metricsets": []string{metricSetName},
"hosts": hosts,
})
module, err := metricbeat.NewModuleWrapper(c, newTestRegistry(t))
if err != nil {
t.Fatal(err)
}
done := make(chan struct{})
output := module.Start(done)
<-output
<-output
close(done)
// Validate that the channel is closed after receiving the two
// initial events.
select {
case _, ok := <-output:
if !ok {
// Channel is closed.
return
} else {
assert.Fail(t, "received unexpected event")
}
}
}
// ExampleModuleWrapper demonstrates how to create a single ModuleWrapper
// from configuration, start the module, and consume events generated by the
// module.
func ExampleModuleWrapper() {
// Build a configuration object.
config, err := common.NewConfigFrom(map[string]interface{}{
"module": moduleName,
"metricsets": []string{metricSetName},
})
if err != nil {
fmt.Println("Error:", err)
return
}
// Create a new ModuleWrapper based on the configuration.
module, err := metricbeat.NewModuleWrapper(config, mb.Registry)
if err != nil {
fmt.Println("Error:", err)
return
}
// Run the module until done is closed.
done := make(chan struct{})
output := module.Start(done)
// Process events from the output channel until it is closed.
var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
for event := range output {
// Make rtt a constant so that the output is constant.
event["rtt"] = 111
fmt.Println(event.StringToPrint())
}
}()
// Simulate running for a while.
time.Sleep(50 * time.Millisecond)
// When finished with the module, close the done channel. When the Module
// stops it will automatically close its output channel so that the output
// for loop stops.
close(done)
wg.Wait()
// Output:
// {
// "@timestamp": "2016-05-10T23:27:58.485Z",
// "_event_metadata": {
// "Fields": null,
// "FieldsUnderRoot": false,
// "Tags": null
// },
// "fake": {
// "status": {
// "metric": 1
// }
// },
// "metricset": "status",
// "module": "fake",
// "rtt": 111,
// "type": "metricsets"
// }
}