diff --git a/README.md b/README.md index e4fd2c2..5466cc6 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Prerequisites: TL;DR: handle the prerequisites above. - git clone https://github.com/stackforge/stacktach-sandbox + git clone https://github.com/openstack/stacktach-sandbox cd sandbox create a mysql database to use set the database url appropriately in winchester.yaml diff --git a/build.sh b/build.sh index f911bf8..f358604 100755 --- a/build.sh +++ b/build.sh @@ -60,7 +60,7 @@ for file in shoebox simport notigen notification-utils \ stackdistiller quincy quince timex \ klugman winchester do - git clone http://git.openstack.org/stackforge/stacktach-$file + git clone http://git.openstack.org/openstack/stacktach-$file done # We still have some stragglers ... for file in StackTach/notabene rackerlabs/yagi diff --git a/docs/about.html b/docs/about.html index 8b3cd7b..b63f858 100644 --- a/docs/about.html +++ b/docs/about.html @@ -152,7 +152,7 @@ max_messages = 100

The important part of this configuration is the [event_worker] section. This says we want to use the RabbitMQ data source. The RabbitMQ connectivity information is stored in the [rabbit_broker] section. The name of each RabbitMQ queue to consume from is specified in the [consumers] section. For every queue you define there, you will need a [consumer:<queue_name>] section. This last section is where there real magic happens. Beyond defining the exchange, routing_key and durability characteristics, it defines the chain of Yagi Handlers that will run on every notification that gets consumed.

-

You can write your own Yagi handlers if you like, but there are a number that ship with StackTach.v3 to do some interesting things. The most important of these is the winchester.yagi_handler:WinchesterHandler. This handler is your entry point into StackTach.v3 stream processing. But first, we need to convert those messy notifications into events ...

+

You can write your own Yagi handlers if you like, but there are a number that ship with StackTach.v3 to do some interesting things. The most important of these is the winchester.yagi_handler:WinchesterHandler. This handler is your entry point into StackTach.v3 stream processing. But first, we need to convert those messy notifications into events ...

Distilling Notifications to Events

Now we have notifications coming into Winchester. But, as we hinted at above, we need to take the larger notification and distill it down into a, more manageable, event. The stack-distiller module makes this happen. Within StackTach.v3, this is part of winchester.yagi_handler:WinchesterHandler.

A notification is a large, nested JSON data structure. But we don't need all of that data for stream processing. In fact, we generally only require a few Traits from the notification. That's what distilling does. It pulls out the important traits, scrubs the data and uses that. Distillations are done via the distillation configuration file (specified in winchester.conf).

@@ -231,7 +231,7 @@ max_messages = 100 - exception.kwargs.uuid - instance.uuid -

For details on the distiller configuration grammar, see the associated docs. Note that the distiller config file is in YAML format.

+

For details on the distiller configuration grammar, see the associated docs. Note that the distiller config file is in YAML format.

When processed, the notification would be converted into an event that looks like this:

A sample event diff --git a/docs/contribute.html b/docs/contribute.html index 8ced293..7c8e904 100644 --- a/docs/contribute.html +++ b/docs/contribute.html @@ -58,9 +58,9 @@

Contributing to StackTach.v3

StackTach.v3 is licensed under the Apache 2.0 license

-

All the source repos for StackTach.v3 (and .v2) are available on StackForge. Details on contributing to StackForge projects are available here

+

All the source repos for StackTach.v3 (and .v2) are available on StackForge. Details on contributing to StackForge projects are available here

The core developers are available on Freenode IRC in the #stacktach channel

-

These docs are available in the Sandbox repo. Patches welcome!

+

These docs are available in the Sandbox repo. Patches welcome!