Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sni committed Dec 18, 2012
1 parent 543ba3c commit 187bd00
Show file tree
Hide file tree
Showing 6 changed files with 2,326 additions and 692 deletions.
3 changes: 3 additions & 0 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ docs/source/backends.png
docs/source/Bookmarks_and_excel_export.png
docs/source/Config_Tool.png
docs/source/Filter.png
docs/source/livestatus.png
docs/source/livestatus_http.png
docs/source/livestatus_mongodb.png
docs/source/MineMap.png
docs/source/Mobile.png
docs/source/multi_site.png
Expand Down
2,794 changes: 2,207 additions & 587 deletions docs/THRUK_MANUAL.html

Large diffs are not rendered by default.

221 changes: 116 additions & 105 deletions docs/THRUK_MANUAL.txt
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ overwritten.

Edit 'cgi.conf' and adjust settings to your needs.

See the <<Configuration>> section for detailed explaination of configuration options.
See the <<Thruk Configuration>> section for detailed explaination of configuration options.



Expand All @@ -382,109 +382,6 @@ Open your browser and open http://<your_host>:3000







== Backend Configuration

=== Livestatus

Livestatus is a addon for Nagios or Icinga which provides realtime
status data. Contrary to database addons it adds very litte overhead to the
nagios core which makes livestatus based gui fast and realtime.

[TIP]
.Shinken
=======
Shinken has livestatus support builtin and does not require additional
modules.
=======

Refer to http://mathias-kettner.de/checkmk_livestatus.html#H1:%20Setting%20up%20and%20using%20Livestatus
on how to install livestatus onto your monitoring box. The
<<_labs_consol_repository,Lab Consol Repository>> has livestatus rpm
packages. For debian based linux systems just use the provided
packages of your distribution.

Basically you have to build the NEB module and add it to your nagios/icinga.cfg.

-------
broker_module=/opt/local/livestatus/livestatus.o /tmp/live.sock
-------

Then use the socket as 'peer' parameter in your backend configuration.

.Thruk Backends
image:source/backends.png[Thruk Backends Manager]



=== HTTP

A HTTP connection is possible between multiple Thruk installations. A
HTTP connection not only makes live data available, it also offers a
secure way to manage object configuration from remote. To authenticate
the origin of the querys, you need to provide the secret key from the
slave instance.

-------
# package installation
%> cat /var/lib/thruk/secret.key

# omd site
OMD[site]:~$ cat var/thruk/secret.key
-------



=== MongoDB
A MongoDB can be used to faster access logfiles. Livestatus caches
logfile data used for querys. This increases the size of the nagios
process, slows down the monitoring and increases the overall load on
your monitoring host. Therefor Thruk may use a MongoDB as logfile
cache.

ex.:

logcache = localhost:27017/thruk_logs


For maximum performance, the MongoDB should be installed on the same
server as Thruk itself.

It's a good idea to import the logfiles after enabling the
logfilecache:

Initial import:
-------
%> thruk -a logcacheimport
-------

Be careful, the 'logcacheimport' deletes all current cached data, so only
do that once.


Logfile Cache Update
-------
%> thruk -a logcacheupdate
-------

The logcacheupdate imports the delta since the last update. Thats pretty
fast and done automatically whenever you access logfiles via Thruk.

There is also a command to check the current usage statistics of your
logfile cache:

-------
%> thruk -a logcachestats
Backend Index Size Data Size Items
Devel 14.4 MB 136.4 MB 238104
-------




== Apache Configuration

Integration in the Apache webserver is done by fastcgi. There are two
Expand Down Expand Up @@ -671,7 +568,119 @@ LoadModule fcgid_module /usr/lib/apache2/modules/mod_fcgid.so
-------


== Configuration




== Backend Configuration

=== Livestatus

Livestatus is a addon for Nagios or Icinga which provides realtime
status data. Contrary to database addons it adds very litte overhead to the
nagios core which makes livestatus based gui fast and realtime.

[TIP]
.Shinken
=======
Shinken has livestatus support builtin and does not require additional
modules.
=======

Refer to http://mathias-kettner.de/checkmk_livestatus.html#H1:%20Setting%20up%20and%20using%20Livestatus
on how to install livestatus onto your monitoring box. The
<<_labs_consol_repository,Lab Consol Repository>> has livestatus rpm
packages. For debian based linux systems just use the provided
packages of your distribution.

Basically you have to build the NEB module and add it to your nagios/icinga.cfg.

-------
broker_module=/opt/local/livestatus/livestatus.o /tmp/live.sock
-------

Then use the socket as 'peer' parameter in your backend configuration.

.Thruk Backends
image:source/backends.png[Thruk Backends Manager]

.Livestatus Architecture
image:source/livestatus.png[Livestatus Architecture]


=== HTTP

A HTTP connection is possible between multiple Thruk installations. A
HTTP connection not only makes live data available, it also offers a
secure way to manage object configuration from remote. To authenticate
the origin of the querys, you need to provide the secret key from the
slave instance.

-------
# package installation
%> cat /var/lib/thruk/secret.key

# omd site
OMD[site]:~$ cat var/thruk/secret.key
-------

.HTTP Architecture
image:source/livestatus_http.png[HTTP Architecture]


=== MongoDB
A MongoDB can be used to faster access logfiles. Livestatus caches
logfile data used for querys. This increases the size of the nagios
process, slows down the monitoring and increases the overall load on
your monitoring host. Therefor Thruk may use a MongoDB as logfile
cache.

ex.:

logcache = localhost:27017/thruk_logs


.MongoDB Architecture
image:source/livestatus_mongodb.png[Mongodb Architecture]

For maximum performance, the MongoDB should be installed on the same
server as Thruk itself.

It's a good idea to import the logfiles after enabling the
logfilecache:

Initial import:
-------
%> thruk -a logcacheimport
-------

Be careful, the 'logcacheimport' deletes all current cached data, so only
do that once.


Logfile Cache Update
-------
%> thruk -a logcacheupdate
-------

The logcacheupdate imports the delta since the last update. Thats pretty
fast and done automatically whenever you access logfiles via Thruk.

There is also a command to check the current usage statistics of your
logfile cache:

-------
%> thruk -a logcachestats
Backend Index Size Data Size Items
Devel 14.4 MB 136.4 MB 238104
-------






== Thruk Configuration

Configuration is managed mainly in these configuration files.

Expand Down Expand Up @@ -2242,3 +2251,5 @@ set downtimes automatically, schedule reports or change the objects
of your monitoring core configuration.

See http://thruk.org/api/Thruk/Utils/CLI.html for details and examples.

There are also some scripting examples in the examples folder.
Binary file added docs/source/livestatus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/livestatus_http.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/livestatus_mongodb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 187bd00

Please sign in to comment.