Thruk

https://thruk.org/documentation
Admin
Thruk is a powerful and flexible monitoring interface for Icinga and Nagios, offering advanced...
Tokens:122,686
Snippets:888
Trust Score:8.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Create and Start OMD Sites

Source: https://thruk.org/documentation/omd-multisite

Creates three OMD sites: one master ('abcmsp') and two clients ('clienta', 'clientb'). It then starts these sites, making them accessible via URLs like https://localhost/sitename.

```bash
omd create abcmsp
omd create clienta
omd create clientb

omd start abcmsp
omd start clienta
omd start clientb
```

--------------------------------

### Create Thruk User and Group

Source: https://thruk.org/documentation/install_from_source

This snippet shows how to create a new user and group named 'thruk' on the system, which is required for installing and running Thruk. All subsequent installation steps should be performed as this user.

```bash
useradd thruk
groupadd thruk
usermod -g thruk thruk
```

--------------------------------

### Thruk Backend Livestatus Configuration

Source: https://thruk.org/documentation/install

This is an example of how to configure a Livestatus backend within Thruk's `thruk_local.conf` file, specifying the socket path for communication.

```Perl
  <Component Thruk::Backend>
      <peer>
          name    = local livestatus
          type    = livestatus
          <options>
              peer    = /var/run/live
          </options>
      </peer>
  </Component>
```

--------------------------------

### Install Thruk Libraries

Source: https://thruk.org/documentation/install_from_source

This section demonstrates how to install the required Perl modules for Thruk. It involves switching to the 'thruk' user, cloning the 'thruk_libs' repository, navigating into the directory, and running 'make' to install the modules into a local destination.

```bash
su - thruk
cd /tmp
git clone git://github.com/sni/thruk_libs.git
cd /tmp/thruk_libs
make
```

--------------------------------

### Clone Thruk Repository and Configure

Source: https://thruk.org/documentation/install_from_source

This code block shows how to clone the main Thruk repository from GitHub, navigate into the directory, and run the configure and make commands to prepare the application for installation.

```bash
cd /tmp
git clone https://github.com/sni/thruk.git
cd /tmp/Thruk
./configure
make
```

--------------------------------

### Run Thruk Application

Source: https://thruk.org/documentation/install_from_source

This section provides commands to run the Thruk application either as a standalone script or using the development server. It also indicates how to access Thruk via a web browser.

```bash
cd ~/Thruk && ./script/thruk
# Or for the development server:
cd ~/Thruk && ./script/thruk_server.pl
# Access via browser: http://<your_host>:3000
```

--------------------------------

### Install Thruk on Debian/Ubuntu

Source: https://thruk.org/documentation/install

This command installs the Thruk package on Debian or Ubuntu systems using dpkg. If dependency errors occur, 'apt-get -f install' can resolve them.

```Shell
#> dpkg -i thruk_1.84_debian6_amd64.deb
```

--------------------------------

### Start Thruk Development Server

Source: https://thruk.org/documentation/faq

Command to start the Thruk development server using the provided script, which listens on a specific port.

```bash
/tmp/Thruk %> ./script/thruk_server.pl -r
HTTP::Server::PSGI: Accepting connections at http://0:3000/
```

--------------------------------

### Start Thruk FastCGI Server (Bash)

Source: https://thruk.org/documentation/install-webserver

This snippet shows how to start the Thruk FastCGI server with a specified number of processes, socket path, and PID file path.

```bash
    %>./script/thruk_fastcgi.pl -n 5 \
                -l /tmp/thruk_fastcgi.socket \
                -p /tmp/thruk_fastcgi.pid
```

--------------------------------

### Move Perl Libraries and Configure PERL5LIB

Source: https://thruk.org/documentation/install_from_source

This snippet details moving the installed Perl libraries from the 'thruk_libs' destination into the main Thruk directory and updating the PERL5LIB environment variable in the user's profile to include the new library path. It also includes instructions to log out and log back in for the changes to take effect.

```bash
mv /tmp/thruk_libs/local-lib/dest/lib/perl5 ~/Thruk/
# Edit your .profile and add the following:
# PERL5LIB=lib:~/Thruk/perl5
# Then logout and login again
```

--------------------------------

### Thruk PNP4Nagios Integration Example

Source: https://thruk.org/documentation/graphing

This example demonstrates how to configure a Nagios service definition to integrate with PNP4Nagios in Thruk. It specifies the 'action_url' to point to the PNP4Nagios installation and includes a class for tooltips.

```Nagios
define service {
  host_name             Example Host
  service_description   Service with Performance Data
  use                   generic_service
  action_url            /pnp4nagios/index.php/graph?host=$HOSTNAME$&srv=$SERVICEDESC$' class='tips' rel='/pnp4nagios/index.php/popup?host=$HOSTNAME$&srv=$SERVICEDESC$
}
```

--------------------------------

### Organize Action Menus in Folder (Thruk Config Example)

Source: https://thruk.org/documentation/configuration

Provides an alternative configuration example for organizing action menus by specifying a folder. This is equivalent to referencing individual JSON files within that folder.

```thruk
action_menu_items_folder    =  /etc/thruk/action_menus/
```

--------------------------------

### Install Puppeteer with Thruk Installer

Source: https://thruk.org/documentation/faq

Command to execute the provided script for installing Puppeteer, a dependency for Thruk's PDF reporting, into the specified directory.

```bash
#> /usr/share/thruk/script/install_puppeteer.sh
```

--------------------------------

### Install OMD Dependencies and OMD

Source: https://thruk.org/documentation/omd-multisite

Installs necessary EPEL repository, the OMD stable repository, and the OMD package on CentOS 7. It also disables SELinux, which is required for Thruk to function correctly.

```bash
# OMD requires some dependencies found in EPEL
yum -y install epel-release
# Install the OMD repo
rpm -Uvh "https://labs.consol.de/repo/stable/rhel7/i386/labs-consol-stable.rhel7.noarch.rpm"
# Install OMD
yum -y install omd
# Thruk will not work with SELinux, so we will go ahead and disable it
setenforce 0
sed -i.bak 's/enforcing/disabled/' /etc/selinux.config
```

--------------------------------

### Thruk HTTP Backend Configuration

Source: https://thruk.org/documentation/install

Configures a Thruk backend to connect to another Thruk installation via HTTP. It specifies the peer address and the authentication method using a secret key from the remote installation.

```perl
<Component Thruk::Backend>
    <peer>
        name    = remote_http
        type    = http
        <options>
            peer  = http://remote_host/thruk/
            auth  = key from remote installation var/thruk/secret.key
        </options>
    </peer>
</Component>
```

--------------------------------

### Set Start Page Link

Source: https://thruk.org/documentation/configuration

Specifies the URL for the Thruk start page, typically pointing to `main.html` which displays version information and general links.

```thruk
start_page = /thruk/main.html
```

--------------------------------

### Thruk Pagination with Limit and Offset

Source: https://thruk.org/documentation/rest

Explains how to implement pagination for Thruk API requests using the 'limit' and 'offset' parameters. 'limit' specifies the number of items per page, and 'offset' determines the starting point for the results. This example retrieves 10 hosts starting from the 101st item.

```bash
%> thruk r /hosts?limit=10&offset=100
```

--------------------------------

### Get Notifications Per Hour by Site

Source: https://thruk.org/documentation/rest_examples

Lists the total number of notifications sent in the last 60 minutes, grouped by backend name. This example uses the Thruk CLI to query notification data.

```bash
thruk r '/notifications?time[gt]=-60m&columns=count(*):notifications_per_hour,peer_name'
```

--------------------------------

### Generate TLS Certificates with makecert.sh

Source: https://thruk.org/documentation/install

A bash script to generate necessary certificates for TLS Livestatus. It requires the remote host's hostname and an email address for certificate creation.

```bash
./makecert.sh remote_host your@email.com
```

--------------------------------

### xinetd Configuration for TLS Livestatus

Source: https://thruk.org/documentation/install

Configures the xinetd service to manage the TLS Livestatus connection. It defines the port, protocol, user, and the stunnel executable with its configuration file.

```ini
service tls_livestatus
{
        type            = UNLISTED
        socket_type     = stream
        protocol        = tcp
        port            = 6557
        wait            = no
        cps             = 100 3
        instances       = 500
        per_source      = 250
        flags           = NODELAY
        disable         = no
        user            = demo
        server          = /usr/bin/stunnel
        server_args     = /omd/sites/demo/etc/stunnel/stunnel.conf
}
```

--------------------------------

### Install Thruk on CentOS/Redhat

Source: https://thruk.org/documentation/install

This command installs the Thruk package on CentOS or Red Hat systems using yum. It may require an external repository like Epel or Rpmforge for the mod_fastcgi module.

```Shell
#> yum install --nogpgcheck thruk-1.84-1.rhel6.x86_64.rpm
```

--------------------------------

### Stop OMD Sites for Configuration

Source: https://thruk.org/documentation/omd-multisite

Stops all running OMD sites ('abcmsp', 'clienta', 'clientb') in preparation for configuration changes, such as enabling Livestatus backends.

```bash
omd stop abcmsp
omd stop clienta
omd stop clientb
```

--------------------------------

### Start Nginx Service

Source: https://thruk.org/documentation/ubuntu-nginx

Starts the Nginx web server service, applying the new configuration.

```bash
#> /etc/init.d/nginx start
```

--------------------------------

### Livestatus Broker Module Configuration

Source: https://thruk.org/documentation/install

This configuration line adds the Livestatus NEB module to your monitoring core's configuration file (e.g., naemon.cfg, nagios.cfg, or icinga.cfg).

```Shell
broker_module=/opt/local/livestatus/livestatus.o /tmp/live.sock
```

--------------------------------

### Thruk Broadcast HTML Example with Macros and CSS

Source: https://thruk.org/documentation/broadcasts

This example demonstrates how to create a Thruk broadcast announcement using HTML, CSS, and predefined macros. It includes an image, formatted text, contact information, and styling for different display contexts. The macros like {{theme}}, {{contact}}, {{contactemail}}, and {{date}} are dynamically replaced.

```HTML
<img src="../themes/{{theme}}/images/ack.gif" width=16 height=16>
<b>Upcoming maintenance change</b>:<br>

<pre style="font-family: inherit;">
Thruk will be updated <font color="red">next wednesday</font>
to the latest release. We are expecting
no downtime but lots of new features.
</pre>

{{contact}} - <a href="mailto:{{contactemail}}">{{contactemail}}</a>
<span style="float: right">(<i>Last Update: {{date}}</i>)</span>

<style>
/* set panorama background color */
DIV.popup-msg .msg {
  background: rgba(240,240,240,0.85);
}
/* background color on other pages */
TABLE.js-broadcast-panel {
  background-color: rgba(255,255,255,0.85);
}
</style>
```

--------------------------------

### Create a Host Object Configuration

Source: https://thruk.org/documentation/omd-multisite

Defines a basic host object configuration for Thruk, specifying the host name, alias, address, and associated contact groups. This configuration is typically saved to a file like /hosts.cfg.

```cfg
save to: /hosts.cfg
host_name: ClientAHost
alias: ClientAHost
address: 127.0.0.1
use: check_mk_host
contact_groups: check_mk
```

--------------------------------

### Sample Service Configuration for Graphite

Source: https://thruk.org/documentation/configuration

An example of a service configuration in Nagios that includes an action_url pointing to a Graphite graph.

```Nagios Configuration
define service{
    service_description   Load
    host_name             localhost
    use                   generic-service
    action_url            http://YOURGRAPHITE/render/?lineMode=connected&width=586&height=308&_salt=1355923874.899&target=cactiStyle($HOSTNAME$.$SERVICEDESC$.*)&xFormat=%25H%3A%25M&tz=Europe/Paris
    check_command         check_load
  }
```

--------------------------------

### Thruk Scripted Dashboard File Permissions Example

Source: https://thruk.org/documentation/dashboard_scripted

An example of file listing output showing permissions for Thruk scripted dashboard files. It highlights that the script file (e.g., '5.tab') must be executable.

```Shell
root@host:/etc/thruk %> ls -la panorama/
-rw-r-----  1 thruk thruk 22185 Aug 12 10:15 1.tab
-rw-r-----  1 thruk thruk 22108 Aug 12 10:15 2.tab
-rw-r--r--  1 thruk thruk 17170 Aug 12 10:15 3.tab
-rwxr-xr-x  1 thruk thruk  5307 Aug 12 10:15 5.tab
```

--------------------------------

### Install mod_ssl Package

Source: https://thruk.org/documentation/faq

This command installs the mod_ssl package, which is necessary to enable SSL/TLS support in the Apache web server for Thruk.

```bash
#> yum install mod_ssl
```

--------------------------------

### Schedule Service Downtime via Thruk CLI

Source: https://thruk.org/documentation/rest_examples

Puts a service into downtime using the Thruk CLI. It requires specifying start time, end time, and a comment for the downtime. Relative time formats are supported.

```bash
thruk r -d "start_time=now" -d "end_time=+60m" -d "comment_data='downtime comment'" '/services/<host>/<svc>/cmd/schedule_svc_downtime'
```

--------------------------------

### Thruk Rule Matching: Multiple Attributes

Source: https://thruk.org/documentation/plugins/agents

Thruk rule matching example requiring a host to start with 'abc' and possess the 'tag1' tag.

```thruk
host = ^abd
tags = tag1
```

--------------------------------

### Add Livestatus Backends in Thruk UI

Source: https://thruk.org/documentation/omd-multisite

Adds Livestatus backend connections within the Thruk UI after restarting the OMD sites. This involves specifying connection details like IP address and the configured Livestatus TCP ports for each client site.

```bash
# In Thruk UI:
# Go to 'Config Tool' > 'Backend / Sites' > 'add new connection'
# For 'name' and 'section', use the client name.
# For 'connection', use '127.0.0.1:6558' and '127.0.0.1:6559' (or your chosen ports).
```

--------------------------------

### Install Nginx and uWSGI Packages

Source: https://thruk.org/documentation/ubuntu-nginx

Installs the necessary Nginx web server and uWSGI plugin for PSGI applications, which are required for running Thruk.

```bash
#> apt-get install nginx-full uwsgi-plugin-psgi
```

--------------------------------

### Thruk Agents Plugin Configuration File

Source: https://thruk.org/documentation/plugins/agents

Example of creating a local configuration file for the Thruk Agents Plugin.

```ini
~/etc/thruk/thruk_local.d/agents.conf
```

--------------------------------

### Configure Thruk Local Settings

Source: https://thruk.org/documentation/install_from_source

This snippet shows how to edit the 'thruk_local.conf' file for local configuration overrides and the 'cgi.conf' file for CGI settings. It emphasizes that 'thruk_local.conf' is used for local changes and is not overwritten during updates, unlike 'thruk.conf'.

```bash
vim thruk_local.conf
vim cgi.conf
```

--------------------------------

### stunnel Configuration for TLS Livestatus

Source: https://thruk.org/documentation/install

Configures stunnel to handle TLS encrypted connections for Livestatus. It specifies the service name, executable for data processing, certificate and key paths, compression, ciphers, verification level, CA file, timeouts, and logging.

```ini
service                = tls_livestatus
exec                   = /usr/bin/timeout
execargs               = timeout 600 /omd/versions/default/bin/unixcat /omd/sites/demo/tmp/run/live
cert                   = /omd/sites/demo/etc/stunnel/server.pem
key                    = /omd/sites/demo/etc/stunnel/server.key
compression            = zlib
ciphers                = AES128-SHA
verify                 = 2
CAfile                 = /omd/sites/demo/etc/stunnel/client.pem
TIMEOUTidle            = 600
debug                  = debug
output                 = /omd/sites/demo/var/log/stunnel.log
syslog                 = no
```

--------------------------------

### Thruk Backend Error Example

Source: https://thruk.org/documentation/faq

Example log messages indicating a 'Backend not available' error in Thruk, often related to Livestatus communication issues.

```log
[ERROR][Thruk.Controller.Root] Caught exception in Thruk::Controller::status->index "socket error at thruk/script/../lib/Monitoring/Livestatus/Class/Base/Table.pm line 186"
[ERROR][Thruk.Controller.error] internal server error
```

--------------------------------

### Rendering Excel Data (Perl)

Source: https://thruk.org/documentation/thruk_2_0_migration_guide

Illustrates the updated method for rendering Excel data using `$c->render_excel()`.

```Perl
return $c->detach('View::Excel'); 

```

```Perl
return $c->render_excel();

```

--------------------------------

### Replacing MyAction Defaults (Perl)

Source: https://thruk.org/documentation/thruk_2_0_migration_guide

Illustrates the replacement of the `MyAction` decorator with a direct call to `add_defaults` for adding database connections and handling backend availability.

```Perl
sub index :Path :Args(0) :MyAction('AddDefaults') {
    my ( $self, $c ) = @_;
    ...

```

```Perl
sub index {
    my ( $c ) = @_;
    return unless Thruk::Action::AddDefaults::add_defaults($c, Thruk::Constants::ADD_DEFAULTS);
    ...

```

--------------------------------

### Setting URL Routes (Perl)

Source: https://thruk.org/documentation/thruk_2_0_migration_guide

Demonstrates the change from using the `Path()` decorator to the `add_routes` function for setting URL routes in Thruk plugins.

```Perl
sub minemap_cgi : Path('/thruk/cgi-bin/minemap.cgi') {
    my ( $self, $c ) = @_;
    return if defined $c->{'canceled'};
    return $c->detach('/minemap/index');
  }
```

```Perl
sub add_routes {
    my($self, $app, $routes) = @_;
    $routes->{'/thruk/cgi-bin/minemap.cgi'} = 'Thruk::Controller::minemap::index';
    return;
  }
```

--------------------------------

### List Active Sessions

Source: https://thruk.org/documentation/rest_examples

Lists sessions that have been active within the last 10 minutes using the Thruk REST API. This example demonstrates filtering and grouping data.

```bash
thruk r '/thruk/sessions?columns=username,max(active)&active[gte]=-10m'
```

--------------------------------

### Thruk Script Execution Example

Source: https://thruk.org/documentation/action-menu

Illustrates how Thruk executes a configured server script, passing host and service details as arguments. It shows the actual command line that Thruk uses when a user clicks an action link.

```bash
/usr/local/bin/sample.sh <hostname> <servicename> argument1 argument2
```

--------------------------------

### Install Thruk on SLES

Source: https://thruk.org/documentation/install

This command installs the Thruk package on SLES systems using zypper. The SLES SDK DVD might be needed for additional dependencies.

```Shell
#> zypper install thruk-1.84-1.sles11.x86_64.rpm
```

--------------------------------

### Example Cronjobs for Logfile Cache Maintenance

Source: https://thruk.org/documentation/logfile-cache

Provides example cron job configurations for automating Thruk logfile cache maintenance tasks, including updates, authentication updates, optimization, cleaning, and compaction.

```bash
# update logcache data
*/5 * * * * $OMD_ROOT/bin/thruk -a logcache update     >>$OMD_ROOT/var/log/thruk.log 2>&1

# update authentication data in our logcache
0   2 * * * $OMD_ROOT/bin/thruk -a logcache authupdate >>$OMD_ROOT/var/log/thruk.log 2>&1

# optimize and repair tables
0  20 * * * $OMD_ROOT/bin/thruk -a logcache optimize   >>$OMD_ROOT/var/log/thruk.log 2>&1

# clean logfiles from cache after default duration (thruk.conf: logcache_clean_duration)
0   1 * * * $OMD_ROOT/bin/thruk -a logcache clean      >>$OMD_ROOT/var/log/thruk.log 2>&1

# compact logfiles from cache after default duration (thruk.conf: logcache_compact_duration)
0   1 * * * $OMD_ROOT/bin/thruk -a logcache compact    >>$OMD_ROOT/var/log/thruk.log 2>&1
```

--------------------------------

### Thruk Grafana/Histou Integration Example

Source: https://thruk.org/documentation/graphing

This example demonstrates how to configure a Nagios service definition to integrate with Grafana/Histou in Thruk by specifying the 'action_url' with the path to the Histou JavaScript file.

```Nagios
define service {
  host_name             Example Host
  service_description   Service with Performance Data
  use                   generic_service
  action_url            /grafana/dashboard/script/histou.js?host=$HOSTNAME$$&service=$SERVICEDESC$
}
```

--------------------------------

### Action Menu Sample Icons (JSON)

Source: https://thruk.org/documentation/configuration

Provides examples of how action menus can be defined with icons, actions (URLs or server commands), and targets. It demonstrates the structure for specifying icons and actions for menu items.

```json
[
  {
    "icon":"../themes/{{theme}}/images/criticity_1.png",
    "action":"http://splunk/abc/hostid=$_HOSTHOSTID$",
    "target":"_blank"
  },
  {
    "icon":"uil-redo",
    "action":"server://refresh/$HOSTNAME$"
  }
]
```

--------------------------------

### Retrieve Thruk Secret Key

Source: https://thruk.org/documentation/install

Commands to retrieve the secret key used for authenticating HTTP connections between Thruk installations. The command varies depending on whether Thruk is installed via package or OMD.

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

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

--------------------------------

### Submit Host Downtime Command (Success)

Source: https://thruk.org/documentation/rest_commands

Example of submitting a command to schedule host downtime and the expected successful JSON response.

```bash
%> thruk r -d "comment_data=test" /hosts/localhost/cmd/schedule_host_downtime
{
  "message" : "Command successfully submitted"
}
```

--------------------------------

### Thruk Background Job Response Example

Source: https://thruk.org/documentation/rest

An example JSON response when a long-running request is started in the background. It includes a `job_id`, a status `message`, a `result_url` to fetch the output, and a `success` flag.

```json
{
    "job_id" : "737aa",
    "message" : "request started in background with job id: 737aa",
    "result_url" : "/thruk/jobs/737aa/output",
    "success" : true
  }
```

--------------------------------

### Thruk Rule Matching: Wildcard Match

Source: https://thruk.org/documentation/plugins/agents

Thruk rule matching example using a case-insensitive wildcard for host names.

```thruk
host = local*
```

--------------------------------

### Thruk Local Configuration Directory Structure Example

Source: https://thruk.org/documentation/configuration

Illustrates the directory structure for local Thruk configuration overrides. It shows how to place configuration files in `thruk_local.d/`, including files that are read on every host and files that are specific to a hostname.

```File System
/etc
`-- thruk
    `-- thruk_local.d
        |-- my.cfg              # will be read on every host
        `-- test.test-machine   # will only be read on a host named `test-machine`
```

--------------------------------

### Thruk Server Action URL Example

Source: https://thruk.org/documentation/action-menu

Demonstrates the pseudo URL format for triggering server actions from Thruk menus or icons. This format allows passing arguments to scripts executed on the server.

```text
server://*scriptname*/argument1/argument2/...
```

--------------------------------

### Basic TT Template for Hello World

Source: https://thruk.org/documentation/plugins

This is a basic TT (Template Toolkit) file that renders the HTML for the 'Hello World' page. It includes standard HTML structure, a title, and displays the 'hello_var' content using the [% hello_var %] notation.

```HTML/TT
<!DOCTYPE html>
<html>
	<head>
		<title>[% title_prefix %][% title %]</title>
		[% PROCESS _favicon.tt %]
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" />
	</head>
	<body>
		<h1>[% hello_var %]</h1> <!-- This is where we access our variable -->
	</body>
</html>
```

--------------------------------

### Thruk Rule Matching: String Match

Source: https://thruk.org/documentation/plugins/agents

Thruk rule matching example for a case-insensitive exact string comparison on the host name.

```thruk
host = localhost
```

--------------------------------

### Removing Catalyst and Moose References (Perl)

Source: https://thruk.org/documentation/thruk_2_0_migration_guide

Provides examples of code to remove when migrating from Catalyst and Moose.

```Perl
use parent 'Catalyst::Controller';

```

```Perl
__PACKAGE__->meta->make_immutable;

```

--------------------------------

### Cookie Handling (Perl)

Source: https://thruk.org/documentation/thruk_2_0_migration_guide

Explains the updated methods for getting and setting cookie values in Thruk plugins.

```Perl
$c->cookies('name')->{'value'}

```

```Perl
$c->cookie('name')->{'value'}

```

```Perl
$c->cookie('name' => 'value', {
            path    => $c->stash->{'cookie_path'},
            domain  => ...,
  });

```

--------------------------------

### Clone Thruk Git Repository

Source: https://thruk.org/documentation/faq

Command to clone the Thruk source code repository from GitHub to set up a development environment.

```bash
/tmp %> git clone git://github.com/sni/thruk.git
```

--------------------------------

### Thruk Configuration File Merge Order Example

Source: https://thruk.org/documentation/configuration

Demonstrates how Thruk merges configuration settings from different files. Simple key-value pairs are overridden, while nested structures are merged, and list values are concatenated. It also shows how to completely reset a list value.

```Thruk Configuration
thruk.conf:
default_theme = Thruk

thruk_local.conf:
default_theme = Company

# results in default_theme = Company

nested values:

thruk.conf:
<initial_menu_state>
  General        = 1
  Current_Status = 1
</initial_menu_state>

thruk_local.conf:
<initial_menu_state>
  Current_Status = 0
  Bookmarks      = 1
</initial_menu_state>

# results in
# <initial_menu_state>
#   General        = 1
#   Current_Status = 0
#   Bookmarks      = 1
# </initial_menu_state>


List values are concatenated.
ex.:
command_enabled = 1-4
command_enabled = 33, 34

# results in:
# command_enabled = 1-4, 33, 34

However, if you want to override a list value completely, you can reset the list by setting it to an empty value:
command_enabled = 1-4
command_enabled =
command_enabled = 33, 34

# results in:
# command_enabled = 33, 34
```

--------------------------------

### Thruk Plugin Directory Structure

Source: https://thruk.org/documentation/plugins

Illustrates the directory structure for managing Thruk plugins, showing available plugins and how to enable them via symlinks.

```Shell
plugins
├── plugins-available
│   ├── conf
│   ├── minemap
│   ├── reports2
│   └── node-control
└── plugins-enabled
    ├── conf             -> ../plugins-available/conf
    ├── minemap          -> ../plugins-available/minemap
    ├── reportss         -> ../plugins-available/reports2
    └── node-control     -> ../plugins-available/node-control

```

--------------------------------

### Thruk Configuration File Paths

Source: https://thruk.org/documentation/install

These are the default file paths for Thruk's configuration files. `thruk_local.conf` is used for local overrides and is never overwritten during updates.

```Text
/etc/thruk/thruk_local.conf
/etc/thruk/cgi.cfg
```

--------------------------------

### Configure Paging Steps for Group Overview

Source: https://thruk.org/documentation/configuration

Sets the selectable paging steps specifically for the groups overview page, similar to `paging_steps`.

```thruk
group_paging_overview =  *3,  10, 100, all
```

--------------------------------

### Create Plugin Directory Structure

Source: https://thruk.org/documentation/plugins

This snippet demonstrates how to create a basic directory structure for a Thruk plugin using the 'mkdir -p' command in Linux.

```bash
mkdir -p hello/{lib/Thruk/Controller,templates}
```

--------------------------------

### Configure Paging Steps for Group Summary

Source: https://thruk.org/documentation/configuration

Sets the selectable paging steps specifically for the groups summary page, similar to `paging_steps`.

```thruk
group_paging_summary = *10, 50, 100, all
```

--------------------------------

### Thruk Configuration Files

Source: https://thruk.org/documentation/index

Details on Thruk's primary configuration files, including thruk_local.conf, cgi.cfg, and Apache/Nginx specific configurations for setting up Thruk.

```text
thruk_local.conf
cgi.cfg
Apache configuration
Nginx configuration
```

--------------------------------

### Reference External Menu via Folder (Thruk Config Example)

Source: https://thruk.org/documentation/configuration

Illustrates referencing a specific menu file from a directory using the `file://` protocol within the Thruk configuration. This is an alternative to using `action_menu_items_folder`.

```thruk
<action_menu_items>
        hostmenu      = file:///etc/thruk/action_menus/hostmenu.json
    </action_menu_items>
```

--------------------------------

### Schedule Service Downtime via cURL

Source: https://thruk.org/documentation/rest_examples

Puts a service into downtime by sending an HTTP request with cURL. This method allows specifying downtime parameters like start time, end time, and comment.

```http
curl -d "start_time=now" --data-urlencode "end_time=+60m" -d "comment_data='downtime comment'" http://0:3000/thruk/r/services/<host>/<svc>/cmd/schedule_svc_downtime
```

--------------------------------

### Manage Thruk FastCGI Init.d Script (Bash)

Source: https://thruk.org/documentation/install-webserver

This snippet demonstrates how to copy, edit, and set permissions for the Thruk FastCGI server init.d script to manage the service.

```bash
    %> sudo cp ./script/thruk_fastcgi_server.sh /etc/init.d/thruk_fastcgi_server
    %> vi /etc/init.d/thruk_fastcgi_server
    %> sudo chown root: /etc/init.d/thruk_fastcgi_server
```

--------------------------------

### Configure Livestatus TCP Ports

Source: https://thruk.org/documentation/omd-multisite

Configures non-standard TCP ports for Livestatus on OMD sites using the 'omd config' TUI utility. This is necessary when multiple sites require Livestatus connections on the same server.

```bash
# Use 'omd config [sitename]' TUI utility
# Navigate to 'Distributed Monitoring' > 'LIVESTATUS_TCP'
# Specify non-standard TCP ports (e.g., 6558, 6559)
```

--------------------------------

### Thruk MySQL Log Cache Configuration

Source: https://thruk.org/documentation/install

Specifies the connection string for using a MySQL database as a logfile cache within Thruk. It includes the database type, username, password, host, port, and database name.

```sql
logcache = mysql://username:password@localhost:3306/thruk_logs
```

--------------------------------

### Schedule Service Downtime with Minimal Parameters via cURL

Source: https://thruk.org/documentation/rest_examples

Schedules a service downtime with only the required comment parameter using cURL. Start and end times will default to current time and default downtime duration, respectively.

```http
curl -d "comment_data='downtime comment'" http://0:3000/thruk/r/services/<host>/<svc>/cmd/schedule_svc_downtime
```

--------------------------------

### Thruk Plugins Overview

Source: https://thruk.org/documentation/index

An overview of available Thruk plugins, including those for SNClient, Business Process, Dashboard (Panorama), Node Control, SLA Reporting, and writing custom plugins.

```text
SNClient Agents
Business Process
Dashboard (Panorama)
Node Control
SLA Reporting
Writing own Plugins
```

--------------------------------

### Action Menu Apply Rules (Thruk Config)

Source: https://thruk.org/documentation/configuration

Configures rules to automatically apply specific action menus to hosts and services based on regular expression patterns. This allows for dynamic menu assignment.

```thruk
<action_menu_apply>
  hostmenu    = .*;               # matches all hosts only
  servicemenu = .*;.+$           # matches all services on all hosts
  specialmenu = ^Host;Service$   # matches an exact service on one host only
  cpu_menu    = .*;CPU           # matches all services starting with 'CPU'
  hostmenu    = ^Host            # matches all hosts starting with 'Host' (incl. services)
  demomenu    = ^Demo;.*$        # matches all services on the 'Demo' host
  demomenu    = ^Test;           # a menu name can be used multiple times
</action_menu_apply>
```

--------------------------------

### Thruk TLS Livestatus Configuration

Source: https://thruk.org/documentation/install

Configures a Thruk backend to connect to a Livestatus service using TLS/SSL encryption. It specifies the peer address, certificate paths for client authentication, and CA file for server verification. The 'verify' option controls hostname and certificate validation.

```perl
<Component Thruk::Backend>
    <peer>
        name    = remote_site
        type    = livestatus
        <options>
            peer    = tls://remote_host:6557
            cert    = /etc/thruk/client.pem
            key     = /etc/thruk/client.key
            ca_file = /etc/thruk/server.crt
            verify  = 1
        </options>
    </peer>
</Component>
```

--------------------------------

### Fetch Host Names via cURL

Source: https://thruk.org/documentation/rest_examples

Retrieves a list of all host names using a cURL HTTP request. This demonstrates how to access the Thruk REST API from the command line, including authentication.

```http
curl -g 'http://user:password@localhost/thruk/r/csv/hosts?columns=name'
```

--------------------------------

### TT Template with Info Boxes and Messages

Source: https://thruk.org/documentation/plugins

This TT template further customizes the 'Hello World' page by incorporating Thruk's standard info boxes and message processing. It includes '_message.tt', '_overdiv.tt', and '_infobox.tt' to display dynamic information and messages, alongside the core content.

```HTML/TT
<!DOCTYPE html>
<html>
	<head>
		<title>[% title_prefix %][% title %]</title>
		[% PROCESS _favicon.tt %]
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" />
		[% PROCESS _common_css.tt %]
		[% PROCESS _header.tt
			css=["plugins/conf/conf.css"]
			js=["plugins/conf/conf.js"]
		%]
	</head>
	<body>
		[% PROCESS _message.tt %]
		[% PROCESS _overdiv.tt %]
		[% PROCESS _infobox.tt %]
		<h1>[% hello_var %]</h1> <!-- This is where we access our variable -->
	</body>
</html>
```

--------------------------------

### Apache Configuration with mod_fcgid

Source: https://thruk.org/documentation/install-webserver

This Apache configuration snippet demonstrates how to integrate Thruk using the mod_fcgid module. It sets up a virtual host, specifies the Thruk root directory, logs, and configures Thruk to run as a fastcgi application. It also includes authentication settings and directives for mod_fcgid.

```apache
LoadModule fcgid_module /usr/lib/apache2/modules/mod_fcgid.so
<VirtualHost *:80>
    ServerName   thruk.company.local

    DocumentRoot /home/thruk/Thruk/root/
    CustomLog    /home/thruk/Thruk/logs/access.log combined
    ErrorLog     /home/thruk/Thruk/logs/error.log

    <Directory /home/thruk/Thruk/root/>
        Options FollowSymLinks
        AllowOverride All
        order allow,deny
        allow from all
    </Directory>

    AliasMatch /thruk/(.*\.cgi|.*\.html)  /home/thruk/Thruk/script/thruk_fastcgi.pl/thruk/$1
    <Location /thruk>
        Options ExecCGI
        Order allow,deny
        Allow from all
        AuthName "Monitoring Access"
        AuthType Basic
        AuthUserFile /home/thruk/Thruk/htpasswd.users
        Require valid-user
    </Location>

    <IfModule mod_fcgid.c> 
      AddHandler fcgid-script .pl
      MaxRequestsPerProcess 100
    </IfModule>

</VirtualHost>
```

--------------------------------

### Thruk: Delete Downtime by Start Time and Comment

Source: https://thruk.org/documentation/rest_commands

Deletes all downtimes matching the specified start time and comment.

```bash
curl -X POST "http://your-thruk-host/thruk/api/system/cmd/del_downtime_by_start_time_comment" -d "start_time=1678886400" -d "comment=Maintenance"
```

--------------------------------

### Thruk Action Wrapper for Security

Source: https://thruk.org/documentation/action-menu

Provides an example of using the `action_wrapper` script to enhance security by checking user and group permissions before executing custom scripts. This helps protect against unauthorized script execution.

```ini
<action_menu_actions>
    scriptname   = .../examples/action_wrapper -u omdadmin -g Admins,Operators ./sample.sh $HOSTNAME$ $SERVICEDESC$
</action_menu_actions>
```

--------------------------------

### Get Timeperiod by Name

Source: https://thruk.org/documentation/rest

Fetches timeperiod details for a given name. This is an alias for the GET /timeperiods?name=<name> endpoint.

```HTTP
GET /timeperiods/<name>
```

--------------------------------

### Define Predefined Action Menu (Thruk Config & Host Config)

Source: https://thruk.org/documentation/configuration

Demonstrates how to define a complete action menu directly within the Thruk configuration file and then reference it in a host configuration. This allows for custom menus to be applied to specific hosts.

```thruk
<action_menu_items>
        standardmenu = {"icon":"/thruk/themes/{{theme}}/images/dropdown.png",
                        "title": "test title",
                        "menu":[
                           {"icon":"uil-redo",
                            "label":"refresh",
                            "action":"server://refresh/$HOSTNAME$"}
                        ]
                       }
    </action_menu_items>
```

```icinga
define host {
  host_name            localhost
  ...
  _THRUK_ACTION_MENU   standardmenu
}
```

--------------------------------

### Thruk API: GET /downtimes/<id>

Source: https://thruk.org/documentation/rest

Retrieves a specific downtime by its ID. This is an alias for GET /downtimes?id=<id>.

```HTTP
GET /downtimes/<id>
```

--------------------------------

### Thruk API: GET /contacts/<name>

Source: https://thruk.org/documentation/rest

Retrieves a specific contact by its name. This is an alias for GET /contacts?name=<name>.

```HTTP
GET /contacts/<name>
```

--------------------------------

### Get Current User Profile

Source: https://thruk.org/documentation/rest

Retrieves information about the currently authenticated user. This endpoint is an alias for GET /thruk/users?id=<id>.

```HTTP
GET /thruk/whoami
```

--------------------------------

### Thruk API: GET /hostgroups/<name>

Source: https://thruk.org/documentation/rest

Retrieves a specific host group by its name. This is an alias for GET /hostgroups?name=<name>.

```HTTP
GET /hostgroups/<name>
```

--------------------------------

### Thruk API: GET /contactgroups/<name>

Source: https://thruk.org/documentation/rest

Retrieves a specific contact group by its name. This is an alias for GET /contactgroups?name=<name>.

```HTTP
GET /contactgroups/<name>
```

--------------------------------

### Fetch Host Names via Thruk CLI

Source: https://thruk.org/documentation/rest_examples

Retrieves a list of all host names using the Thruk command-line interface. This command queries the CSV endpoint for hosts and specifies the 'name' column.

```bash
thruk r /csv/hosts?columns=name
```

--------------------------------

### Get Thruk User Profile

Source: https://thruk.org/documentation/rest

Fetches the Thruk profile for a specific user identified by their ID. This is an alias for the GET /thruk/users?id=<id> endpoint.

```HTTP
GET /thruk/users/<id>
```

--------------------------------

### Thruk: Authorize Business Processes Creation

Source: https://thruk.org/documentation/cgi-cfg

Allows users to create and edit business processes. Assignment is done via a comma-delimited list.

```sh
authorized_for_business_processes = thrukadmin
```

--------------------------------

### Enable Nginx Site Configuration

Source: https://thruk.org/documentation/ubuntu-nginx

Creates a symbolic link to enable the Thruk Nginx site configuration file, making it active for the web server.

```bash
#> ln -s /etc/nginx/sites-available/thruk /etc/nginx/sites-enabled/thruk
```

--------------------------------

### Enable uWSGI Thruk Application Configuration

Source: https://thruk.org/documentation/ubuntu-nginx

Creates a symbolic link to enable the Thruk uWSGI application configuration file, making it available for the uWSGI server.

```bash
#> ln -s /etc/uwsgi/apps-available/thruk.ini /etc/uwsgi/apps-enabled/thruk.ini
```

--------------------------------

### Increase Log Threshold Example

Source: https://thruk.org/documentation/logfiles

This example demonstrates how to change the log threshold for a specific appender (ThrukLog) to DEBUG in the log4perl configuration file. This allows for more detailed logging information to be captured.

```Perl
log4perl.appender.ThrukLog.Threshold=DEBUG
```

--------------------------------

### Thruk Static Cluster Configuration

Source: https://thruk.org/documentation/cluster

Configures a Thruk cluster with a fixed number of nodes by specifying multiple 'cluster_nodes' with distinct hostnames. This ensures a predictable cluster setup.

```thruk
cluster_enabled = 1
cluster_nodes = http://clusternode1/$url_prefix$/
cluster_nodes = http://clusternode2/$url_prefix$/
```

--------------------------------

### Thruk Custom Action Icon Example

Source: https://thruk.org/documentation/graphing

This example shows how to set a custom action icon for a specific host or service in Thruk using the '_ACTION_ICON' custom variable in the service definition.

```Nagios
define service {
  ...
  _ACTION_ICON          action_pnp.png
}
```

--------------------------------

### Thruk Time Arithmetic Examples

Source: https://thruk.org/documentation/timedefinitions

Demonstrates how to use time arithmetics in Thruk for defining time ranges. It shows examples of basic calculations and the use of human-readable suffixes for time units.

```Thruk Time Definition
today - 2d
```

```Thruk Time Definition
lastmonday + 86400
```

```Thruk Time Definition
lastmonday + 1d
```
Tokens:
Raw