General

You can view, track, and monitor tenant activities. This feature displays audit logs, shows the current month's transaction usage statistics for transaction-based tenants, and clears storage locks for integrations.

Audit Logs

The Audit Logs section keeps a record of all user activities. It tracks actions that are performed, detailing the type of action, the user responsible, and the date and time of each action

For the Develop Anywhere, Deploy Anywhere and Central Control, Distributed Execution capabilities, audit logs are supported for the following operations:

  • Create edge runtime
  • Create a cloud runtime
  • Add OAuth 2.0 token
  • Update an edge runtime description
  • Enable or disable the runtime
  • Unregister an edge runtime
  • Cancel or timeout edge runtime registration
  • Delete an edge runtime instance
  • Sync a develop anywhere flow service

To access the tenant audit logs, go to the tenant home screen and then click Monitor > Audit Logs.

Using Filters in Audit Logs

You can apply filters to the audit logs to retrieve specific entries.

Filter Logs by Time-range Selector

You can view audit logs for a specific time frame by using the date picker in the upper-right of the Audit Logs section.

By default, you see the logs from the last 12 hours. You can either choose the time-range menu to select the time range or specify the start and end date to fetch the audit logs created between them.
  • 12 h - Fetch audit logs for the last 12 hours from the current time.
  • 1 Day - Fetch audit logs for the previous day and the current time of today.
  • 1 Week - Fetch audit logs for the previous week and the current time of today.
  • 2 Weeks - Fetch audit logs for the last two weeks and the current time of today.
  • 3 Weeks - Fetch audit logs for the last three weeks and the current time of today.
  • 4 Weeks - Fetch audit logs for the last four weeks and the current time of today.
Note: The maximum custom date range that you can specify is 30 days.

Filter Logs by Search Query

You can perform two types of searches, Simple Search and Advanced Search, to search and view log events based on your requirements. You can search and filter a set of particular log entries by specifying a search term or a query expression in the search query box.

Supported Query Expressions

Using an advanced search capability, you can combine multiple search terms with different operators to perform a more specific search. A query expression can either consist of multiple search terms that are separated by commas or multiple search terms that are grouped with parentheses.

Following are the different query expressions that you can perform:

  • Query Expression = search_term1, search_term2

    A query that has search terms that are separated by a comma returns log entries containing the specified values in the same row. For example, the query - Project, Delete - will search for log entries containing Project and Delete in the same row.

  • Query Expression = (search_term1) OR (search_term2)

    Multiple queries with search terms joined by an OR operator with each query that is grouped with parentheses returning log entries that contain either or both of the search terms in the same row. For example, the query - (Project, Delete) OR (Untitled Workflow) - will search for log lines that contain either Project and Delete or Untitled Workflow or both in the same row.

  • Query Expression = (field1:search_term1, field2:search_term2)

    A query with field-based searches returns the log entries where the attribute equals the specified value in the same row. For example, the query - (module: project, action: create) will search for log lines where the module - project equals action - create in the same row.

Supported Operators

A query expression allows the following operators:

Operator Example Description
OR (Project, Delete) OR (Default) Searches for log entries containing either or both of the specified search terms in the same row
, (comma) Project, Delete Searches for log entries containing all the specified search terms in the same row
: (colon) (module:project, action:delete) Searches for log entries where the field equals the specified value

Example Query Expressions

The following are examples of a few query expressions for searching a specific set of log entries:

Query Expression Description
workflow, delete Retrieve log entries containing workflow and delete in the same row
created, johndoe Retrieve log entries for which the 'Created' action is performed by 'johndoe'
(created, johndoe) OR (updated, johndoe) Retrieve log entries for which the 'Created' or 'Updated' action is performed by 'johndoe'
(published, janesmith) OR (published, johndoe) OR (published, veronicasmith) Retrieve log entries for projects that are published by 'janesmith', 'johndoe' , or 'veronicasmith'
(module: project, action: delete) Retrieve log entries where the column fields - 'module' and 'action' equal values - 'project' and 'delete' respectively

Downloading Audit Logs

You can download the audit logs (all or filtered records) either in JSON or CSV format to your local system.

Click Download Logs at the upper-right of the Audit Logs screen.

Next, select the format type of audit log report that you want to download.

The audit logs are downloaded to the default download location in your local system.

Usage

Note: This option is visible only if transactions are enabled for your tenant.

For all transaction-based tenants, some transactions are allocated to their account depending on the selected plan monthly. You can view the current month's transaction usage statistics of your transaction-based tenants through the Usage tab.

Note: Paid tenants access a different Transaction Usage screen compared to nonpaid and Free Forever Edition (FFE) tenants.

For nonpaid and Free Forever Edition tenants:

To view the transaction usage of your tenant, go to the homescreen and then click Monitor > Usage.

Here, you can check the number of transactions that are already used by your tenant workflows and Flow services out of the total allocated transactions, for the current month.

Note: To upgrade your plan and access more transactions, contact IBM® Support.

For paid tenants:

The usage bar that is not visible to nonpaid and Free Forever Edition (FFE) tenants. Only the total number of transactions that are used is displayed when you click the Usage tab.

Clear Storage Locks

Storage locks are a mechanism that temporarily locks or marks a shared storage resource (such as a storage service or scheduled integrations with the Prevent concurrent executions option) during an integration's execution. This prevents other processes from interfering. IBM webMethods Integration uses a short-term store for information that needs to persist across server restarts.

The lock mechanism is used to control access and execution of integrations to avoid conflicts, especially in scenarios where multiple processes or instances might interact with the same data or resources concurrently. Locks ensure that only one instance of an integration or process is executed at a time, preventing issues like data inconsistency or resource conflicts. This is achieved by acquiring a lock on a storage resource before performing operations on it and releasing the lock afterward to allow other processes to access the resource.

The IBM webMethods Integration system automatically removes integration locks at scheduled intervals, occurring every 1 hour and 15 minutes. However, if you want to manually clear the locks before the designated time, you can clear the locks from the Clear Storage Locks page.

Note: The Clear Storage Locks feature is applicable only for Flow services.
The following are instances when the locks are applied on an integration, and you must manually clear the locks:
  • Scenario 1

    When you select the Prevent concurrent executions checkbox while scheduling an integration, a lock is applied to the integration before each execution. If a system outage occurs while the integration is running, the lock remains in place and is not automatically released. As a result, subsequent executions are skipped until the lock is manually cleared. If you attempt to rerun the integration, it fails at the storage lock step due to the unresolved lock. Clearing the lock from the Clear Storage Locks page allows the current execution to resume.

  • Scenario 2

    When you add the Storage add and lock services in an integration, a lock is applied and automatically released upon the completion of the integration. If a system outage occurs during the integration's execution, the lock remains in place and is not automatically released. Therefore, subsequent executions are skipped until the lock is manually cleared. If you stop debugging an integration after the lock step, the lock remains. Manually clear it from the Clear Storage Locks page. However, if debugging completes up to the last step, the lock is automatically released.

  • Scenario 3

    If an integration runs for several hours (for example, exceeding 1 hour and 15 minutes) and acquires a lock throughStorage add and lock services or by using the Prevent concurrent executions option in the scheduler, IBM webMethods Integration automatically releases the lock during its routine lock removal schedule, even if the integration is still running. To prevent this scenario and extend the lock removal time, contact Support.

Accessing Clear Storage locks

  1. Go to Monitor > General > Clear storage locks.

    The Clear Storage Locks page displays the following details:

    • Storage Context – The name that is given to the storage when the storage service is added to the integration.
    • Key – The name of the storage key used when the storage service is added.
    • Locked On – The date and time when the lock was applied to the integration.

Clearing Storage Locks

  1. Go to Monitor > General > Clear storage locks. This action displays all integrations with applied locks.
  2. Select the checkboxes corresponding to the integrations for which you want to release the lock.
  3. Click Clear. The lock is cleared and the integration is run successfully.