Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleSTEP 1: Look at the way logs are stored on the disc

Look at the bottom of your Logs screen. You should see something like:

Image Removed

You can physically examine how Iguana stores the log files. In Mac OS X:

  • Copy the location

  • Open the Finder application

  • Use the Shift + ⌘ + G to open a window lets you change the directory which you can copy paste the logs location into:

Image Removed

In this way you can see how Iguana stores the logs for each component:

Image Removed

Each component has its own directory.

Each directory represents hexadecimal digits in Unix epoch time. Unix epoch time is the number of seconds since January 1st 1970. The structure of logs is design to facilitate fast random access to the data and makes it fast to dequeue and search the log data.

Expand
titleSTEP 2: Check the log browser to see how much disc space is used by your logs

From the Logs tab look down and click on the Manage link.

Image Removed

Expand
titleSTEP 3: Click stats to view log usage settings and then clear the logs of one component

With Iguana X is it no problem to clear the logs of each component individually.

You can choose to get rid of test channel data or ‘chatty’ interfaces, while keeping important production data for decades.

Image Removed

...

titleSTEP 4: Set up automated purging rules for your log data.

Locate Purging section of the Settings:

...

This will show a set of rules that can be applied to your components to control how the automatic midnight purge affects their logs. Purge Rules are matched in the order they appear in the table, if a component’s description contains multiple matches the first rule matched will apply.

Setting up rules:

  1. Click EDIT at the top right of the page. Then make a rule that all your components with #prod Never have their data purged and click Save:

...

Iguana X supports glob expression (*), boolean(and/or), or regular expressions (regex) with Tags to create matching rules. To use regex, simply enclose the expression in slash characters /<regex>/. The table below provides an overview of example pattern matching techniques you can combine to create a matching rule.

...

Type

...

Example

...

Description

...

Wildcard

...

*

...

Apply to all components.

...

#dev*

...

Apply to components with #dev followed by 0 or more characters

...

OR

...

#prod #dev

...

Apply to components with either #prod OR #dev tags.

...

AND

...

“#prod #dev“

...

Apply to components with both #prod AND #dev tags.

...

Negation

...

-#prod

...

Apply to all components without the #prod tag.

...

“#prod -#dev”

...

Apply to all components with the #prod tag AND without #dev.

  1. Make another Purge Rule that channels with #device will be purged when they have 30 days of logs because they are chatty and click Save:

...

  1. Make another Purge Rule for all your test components to be purged daily:

    1. The first thing to do is label your test components with #test, to do this navigate to your Source and Destination component cards by double clicking them on the dashboard.

    2. Edit the Tags field in the Component Card to add the #test rule (Make sure your Component is OFF).

    3. Repeat the same 2 steps for the Source Component as well.

    4. Go back to Purging in the Settings.

    5. Add the rule for #test components to be purged daily and click Save:

      Image Removed

A convenient way to limit the amount of logs stored by all components is to define a purge rule with * and configuring it to purge after a set number of days.

...

titleSTEP 5: Test out your purge rules by clicking the test rules button

Now that some purge rules are defined, and components have been given hashes, test out what would happen if a purge was done now by clicking Test Rules.

You can sort the columns in the Testing purge rules table to efficiently view the rules affects.

...

Iguana’s Logs contain service information, user activity, and all transactions which can contain sensitive data. Log management is crucial as the logs are integral to Iguana's operations.

Info

For proper log management, it’s important to understand how the logging and queueing system works and how the logs are stored and structured.

Expand
titleSecure and backup and Log Directory

Logs are stored in the log directory. If required, you can change the Log Directory. Configure a separate folder for logs on a designated partition or drive with good read/write speeds for low latency. 

Add additional layers of security on your log directly by implementing:

Expand
titleMonitor your Log Directory disk space and set log purge rules

Avoid interruptions that can be caused if Iguana cannot write to the log storage because it is out of space.

  • Manage your log storage with Log Purge Rules. Logs older than the defined log age will be automatically deleted by Iguana’s daily log purge at midnight. The default log age is 7 days. Purge rules can be applied to one or more components using a matching rule. Your ideal log age may depend on your log sizes and requirements around how long you need to keep messages for troubleshooting. 

  • Monitor your disk space on the Log Usagepage. Here, you can see total disk space used, free space, and a breakdown of log sizes of each component, giving you comprehensive information to determine appropriate log purge rules for your Iguana.

Expand
titleBackup your logs regularly

Logs contain all transactions and play a key role in troubleshooting integrations. The Logs directory should be backed up regularly. See Backing up Iguana for backup procedure best practices.