> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/manual/english/platform-usage/siem/required-services/loggernaut.md).

# Loggernaut

Loggernaut is an Enginsight component that acts as the central control element of the Enginsight SIEM. It enables communication between the SIEM Management Server, SIEM Index Server, and the Enginsight platform.

{% hint style="warning" %}
**Please note**: [Indexed log collections](#left-side-indexed-log-collections) and the [processor overview](#right-side-processor-overview) are only available for the organization that is responsible for the management of the SIEM cluster. This corresponds to the organization that you [defined during the installation of the SIEM Management Server](https://docs.enginsight.com/docs/manual/english/installation-and-configuration/installation-and-configuration/enginsight-siem/siem-management-server.md#updating-the-application-server).
{% endhint %}

***

## Important Notes

**Loggernaut Backups**

* Backups are automatically created by Loggernaut on the specified storage server once per hour. The backup includes all log files larger than 100 MB.
* When Loggernaut is restarted, backups are created once immediately. After that, backups are created automatically every hour again.

{% hint style="success" icon="lightbulb" %}
For more information on Loggernaut backups, see our Knowledge Base: [How can I adjust the retention period for my log backups in the Enginsight SIEM?](https://docs.enginsight.com/docs/knowledge-base/english/siem/how-can-i-adjust-the-retention-period-for-my-log-backups-in-the-enginsight-siem) and [How can I create an external backup of my raw logs in the Enginsight SIEM?](https://docs.enginsight.com/docs/knowledge-base/english/siem/how-can-i-create-an-external-backup-of-my-raw-logs-in-the-enginsight-siem)
{% endhint %}

***

<i class="fa-compass">:compass:</i> Navigate to **SIEM** → **Loggernaut** to view an overview of the functionality and utilization of all installed Loggernaut components.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F2gNAjiu993CPUjE56rET%2FEnginsight-EN-SIEM-Loggernaut-Full.jpg?alt=media&amp;token=35716bbe-5e9c-412b-a007-17499401fa94" alt=""><figcaption></figcaption></figure>

***

## Left Side: Indexed Log Collections

This section show all log collections that are already indexed by each Loggernaut, including their subordinate shards (partitioned segments) and nodes.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F4mT3lm807MJM4UqlMxvW%2FEnginsight-SIEM-Loggernaut-Collections.jpg?alt=media&amp;token=11e8b93d-b6d3-4e0f-bf09-8d5e409bdccf" alt="" width="347"><figcaption></figcaption></figure></div>

The following information is shown:

<table><thead><tr><th width="200.4921875">Information</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>Shows the URL of the Apache Solr cluster on the SIEM Index Server.</td></tr><tr><td>Version</td><td><p>Shows the version number of the currently installed Loggernaut.</p><p></p><p>If the installed Loggernaut version is outdated, the <strong>Update Available</strong> button is also shown.</p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Update Available</strong> to install the latest Loggernaut version.</p></td></tr><tr><td>Collections</td><td><p>Shows an overview of all collections that are used to store log data.</p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click the <strong>Expand</strong> icon <i class="fa-caret-right">:caret-right:</i> next to a collection to show all associated shards. Click the <strong>Collapse</strong> icon <i class="fa-caret-down">:caret-down:</i> to collapse all fields again.</p></td></tr><tr><td>Status</td><td><p>Shows the status of the collection.</p><p></p><p>The following states can be shown:</p><ul><li><strong>Green</strong>: All replicas are active (100%) and a shard leader is available.</li><li><strong>Yellow</strong>: More than 50% but fewer than 100% of the replicas are active, and a shard leader is available.</li><li><strong>Orange</strong>: Up to 50% of the replicas are active, but at least one replica is still available, and a shard leader is available.</li><li><strong>Red</strong>: No active replicas are available, or no shard leader is available.</li></ul><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note</strong>: If a collection shows a status other than <strong>Green</strong>, contact our Support team immediately.</p></div></td></tr><tr><td>Shards</td><td><p>Shows all shards of a collection that are used for distributed data storage.</p><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click the <strong>Expand</strong> icon <i class="fa-caret-right">:caret-right:</i> next to a shard to show all cores associated with that shard. Click the <strong>Collapse</strong> icon <i class="fa-caret-down">:caret-down:</i> to collapse all fields again.</p></td></tr><tr><td>Nodes</td><td><p>Shows the specific nodes on which the log data is stored, together with their status.</p><p></p><p>The following additional information is shown:</p><ul><li><strong>Name</strong>: Shows the name of the node.</li><li><strong>State</strong>: Shows the status of the node.</li><li><strong>Node</strong>: Shows the IP address and port of the node.</li><li><strong>IndexSize</strong>: Shows the size of the node's index in MB.</li><li><strong>NumDocs</strong>: Shows the number of documents that are stored on this node.</li></ul></td></tr></tbody></table>

***

## Center: Field Statistics

This section shows information about the number of incoming raw logs before they are indexed.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F7Mmvz8LGAMmTOA7EWURK%2Fenginsight-screenshot-siem-required%20services-loggernaut-center-field%20statistics.jpg?alt=media&amp;token=2902d6a4-29b4-41ad-9a58-cf05108ee2c2" alt="" width="316"><figcaption></figcaption></figure></div>

The following information is shown:

<table><thead><tr><th width="200.4921875">Information</th><th>Description</th></tr></thead><tbody><tr><td>1 Minute (∑)</td><td>Shows the average number of logs that are received over a one-minute period.</td></tr><tr><td>5 Minutes (∑)</td><td>Shows the average number of logs that are received over a five-minute period.</td></tr><tr><td>15 Minutes (∑)</td><td>Shows the average number of logs that are received over a 15-minute period.</td></tr><tr><td>1 Minute (/s)</td><td>Shows the average number of logs that are received per second over a one-minute period.</td></tr><tr><td>5 Minutes (/s)</td><td>Shows the average number of logs that are received per second over a five-minute period.</td></tr><tr><td>15 Minutes (/s)</td><td>Shows the average number of logs that are received per second over a 15-minute period.</td></tr></tbody></table>

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Table** icon <i class="fa-table-cells-columns">:table-cells-columns:</i> to show additional information in the [field statistics detail view](#field-statistics-detail-view).

### Field Statistics: Detail View

The Field Statistics detail view is structured as a table.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FWKnWvyLyDjk3tKArW6nb%2Fenginsight-screenshot-siem-required%20services-loggernaut-center-field%20statistics-detail%20view.jpg?alt=media&amp;token=88e4b65e-88b3-46c1-9464-60fe95810e0b" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="200.49609375">Column</th><th>Description</th></tr></thead><tbody><tr><td>Host</td><td><p>Shows the name of the host from which Loggernaut received logs.</p><p><br><i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a host to navigate to the respective <a href="https://docs.enginsight.com/docs/manual/english/platform-usage/host-detail-view.md">host detail view</a>.</p></td></tr><tr><td>T-1</td><td>Shows the number of logs that were received from the respective host over a one-minute period.</td></tr><tr><td>T-5</td><td>Shows the number of logs that were received from the respective host over a five-minute period.</td></tr><tr><td>T-15</td><td>Shows the number of logs that were received from the respective host over a 15-minute period.</td></tr></tbody></table>

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Data Lake** icon <i class="fa-water">:water:</i> at the end of a list item to show the corresponding logs in the [data lake](https://docs.enginsight.com/docs/manual/english/platform-usage/siem/data-lake.md).

***

## Center: Performance Overview

This section contains two line charts that provide information about Loggernaut performance.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2Fup6kvlf9jy7zWeBI7UJR%2Fenginsight-screenshot-siem-required%20services-loggernaut-center-performance%20overview.jpg?alt=media&amp;token=b8079b6e-817b-45c7-8f38-20474b1ab6cf" alt="" width="328"><figcaption></figcaption></figure></div>

The following information is shown:

<table><thead><tr><th width="219.79296875">Metric</th><th>Description</th></tr></thead><tbody><tr><td>Average Query Time</td><td>Shows the average time Loggernaut requires to search logs over time.</td></tr><tr><td>Average Index Time</td><td>Shows the average time that is required to index incoming logs over time.</td></tr></tbody></table>

<i class="fa-arrow-pointer">:arrow-pointer:</i> Hover over a line to show the value at a specific point in time.

***

## Right Side: Processor Overview

This section shows information about the utilization of the SIEM Index Servers in use.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F48AH7mYjZv1WAe4RWRkR%2Fenginsight-screenshot-siem-required%20services-loggernaut-center-processor%20overview.jpg?alt=media&amp;token=6ebd6b00-d2df-4a1e-8dda-4d39f7faf36b" alt="" width="563"><figcaption></figcaption></figure></div>

The following information is shown:

<table><thead><tr><th width="199.98828125">Metric</th><th>Description</th></tr></thead><tbody><tr><td>Heap</td><td>Shows the utilization of the Docker containers in use as a percentage.</td></tr><tr><td>RAM</td><td>Shows the memory usage on the SIEM Index Server as a percentage.</td></tr><tr><td>Disks</td><td>Shows the remaining disk space on the SIEM Index Server as a percentage.</td></tr></tbody></table>

Depending on the utilization level, the gauge indicators are shown in different colors:

* **Green**: Resource utilization is ≤50%.
* **Yellow**: Resource utilization is 51–70%.
* **Orange**: Resource utilization is 71–95%.
* **Magenta**: Resource utilization is >95%.

***

## Further Resources

**Knowledge Base**

* [How can I adjust the retention period for my log backups in the Enginsight SIEM?](https://docs.enginsight.com/docs/knowledge-base/english/siem/how-can-i-adjust-the-retention-period-for-my-log-backups-in-the-enginsight-siem)
* [How can I create an external backup of my raw logs in the Enginsight SIEM?](https://docs.enginsight.com/docs/knowledge-base/english/siem/how-can-i-create-an-external-backup-of-my-raw-logs-in-the-enginsight-siem)

***
