> For the complete documentation index, see [llms.txt](https://docs.digitalriver.com/woocommerce/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalriver.com/woocommerce/1.0-1/developer-documentation/module/api-logger-module.md).

# Logger module

This module is useful for logging events related to products, orders, and charges. You can enable or disable logging directly from the **Settings** page `WooCommerce->Settings->Payment(tab)`. 

All the logs are written to the `uploads/digitalriver/logs` directory. View the logs from the **Admin Dashboard** by going to `WooCommerce->Status->Logs`.   

## Specifications

This module logs data for all the [modules](/woocommerce/1.0-1/developer-documentation/module.md).

The log method will be triggered for the following API calls:

* `SKU`–Product Sync API calls
* `Order`–status and transaction API calls
* `Customer`–read and created into Digital River API calls
* `Checkout`–created and updated API calls
* `Tax calculation`–API calls 

All logs are written to specific folder-wise log files if logging is enabled from gateway settings. Find the settings in WooCommerce by selecting **Settings** and clicking the **Payment** tab under the **Digital River Gateway** section. The transaction details are displayed in a meta box on the **Order Edit** page. 

The relationship between the WooCommerce order and the Digital River order is maintained by storing the Digital River order ID as `order post_meta` managed by the `order sync` module. 

The `Logger` module will only fetch the `dr_order_id` meta value and display the logs of that order. A new log file will be created for each object. 

## Naming conventions

* `Order` related log files will be stored in `uploads/digitalriver/logs/orders/[order_id].log`.
* `SKU` related logs will go to the `uploads/digitalriver/logs/products/[product_id].log` log file. 
* `Customer` related logs will go to the `uploads/digitalriver/logs/customers/[customer_id].log` log file.
* `Checkout` related logs will go to the `uploads/digitalriver/logs/checkouts/[checkout_id].log` log file.
* `Payment Source` related logs will go to the `uploads/digitalriver/logs/sources/[source_id].log` log file.
* Any other logs will go to the `uploads/digitalriver/logs/default.log` file.
* Error logs will go to the `uploads/digitalriver/logs/errors.log` file.

### How to log an object

Trigger the action `digitalriver.api_success` with the following three parameters:

* Object
* Event name
* Action type `(CREATE / UPDATE / DELETE)`

  **Example**: `do_action( 'digitalriver.api_success', $object, $event, $action )`

Currently, the following objects are supported as a stand-alone. The remaining objects are handled by the `GenericHandler`. 

* `Checkout`
* `Customer`
* `Order`
* `SKU`
* `Source`
* `Throwable`

### Customize how to log an object

To customize how to log an object:

1. Create a new object extending the `GenericHandler`.
2. Modify the methods `get_log_line` and `get_relative_path` as per your requirements.
3. Add a new method to the `dr_log_handler` hook.
4. The method must check whether the `classname` matches the object of interest and then return the newly created `Handler` object. 

### Log an error

Trigger the action `digitalriver.api_error` with the error as a parameter.  \
**Example**: `do_action( 'digitalriver.api_error', $exception )` 

## Logger methods

### Logger class

This class listens to events and logs them by using different `Handler`s for logging data types.

| Method       | Args, Returns, and Descriptions                                                                                                                                                                                                                                                                    |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name         | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: string </p><p><strong>Description</strong>: Returns the name of the module</p>                                                                                                                                                           |
| init         | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Initializes the module</p>                                                                                                                                                                      |
| log          | <p><strong>Arg</strong>: Object $data, String $event, String $action</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Takes in the object, the event name, and the type of action <code>(CREATE / UPDATE / DELETE)</code> and logs the data to the appropriate log file</p> |
| error\_log   | <p><strong>Arg</strong>: <code>Throwable</code> $exception</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Takes in the Exception and logs the error message to the <code>errors.log</code> file</p>                                                                       |
| get\_handler | <p><strong>Arg</strong>: Object $object</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Takes in an object and returns an appropriate handler for logging the object</p>                                                                                                   |

#### Logger Container class

This class acts as a Dependency Injection container for providing dependencies to classes present in the `Logger` module.

| Method           | Args, Returns, and Descriptions                                                                                                                                                                                                  |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \_\_construct    | <p><strong>Arg</strong>:<code>PimpleContainer</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Accepts a Dependency Injection Container as an argument and assigns it to a container attribute</p> |
| define\_services | <p><strong>Arg</strong>:<code>-</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Defines all the classes present within the module</p>                                                             |

#### Logger View class

This class takes care of adding a new tab where the `digitalriver` logs can be displayed in the WooCommerce **Status Menu** tab.

| Method                 | Args, Returns, and Descriptions                                                                                                                                                                        |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| init                   | <p><strong>Arg</strong>:<code>-</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Initializes the module</p>                                                              |
| add\_tab               | <p><strong>Arg</strong>: array $tabs</p><p><strong>Return</strong>: array</p><p><strong>Description</strong>: Adds a new tab called <code>Digital River Logs</code> under WooCommerce->Status menu</p> |
| render                 | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Renders the content to be displayed on the <code>Digital River Logs</code> tab</p>                  |
| get\_logger\_files     | <p><strong>Arg</strong>: String $path</p><p><strong>Return</strong>: array</p><p><strong>Description</strong>: Receive a directory path as an argument and return all the log files present in it</p>  |
| remove                 | <p><strong>Arg</strong>: String $handle</p><p><strong>Return</strong>: bool</p><p><strong>Description</strong>: Removes the file passed in as an argument</p>                                          |
| get\_log\_file\_handle | <p><strong>Arg</strong>: String $filename</p><p><strong>Return</strong>: string</p><p><strong>Description</strong>: Receives the filename as an argument and returns the log filehandle</p>            |
| delete\_log            | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Receives the filehandle from <code>$\_REQUEST</code> and delete the log file</p>                    |
| delete\_all\_log       | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Deletes all the log files</p>                                                                       |

#### Metabox class

This class adds a metabox to the **Order Edit** page to display the order-related logs. The logs are fetched from the log file.

<div align="left"><img src="/files/-Mbr7qQsQ9br267BQ4B8" alt=""></div>

| Method                        | Args, Returns, and Descriptions                                                                                                                                                                                                             |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| init                          | <p><strong>Arg</strong>:<code>-</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Registers callback to display the metabox by making a call to the <code>order\_logs\_metabox()</code></p>                    |
| order\_logs\_metabox          | <p><strong>Arg</strong>:<code>-</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Adds the metabox to the order edit screen and registers content callback as <code>order\_logs\_metabox\_content()</code></p> |
| order\_logs\_metabox\_content | <p><strong>Arg</strong>:<code>-</code></p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Displays order-related logs inside a Textarea HTML element within the metabox</p>                                            |

### Interfaces

The Logger module defines the `Handler` and `ErrorHandler` interfaces.

#### Handler interface

This interface declares a single method that must be implemented by all the Handlers. A new Handler class must be created for every object type.

| Method              | Args, Returns, and Descriptions                                                                                                                                                               |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| set\_data           | <p><strong>Arg</strong>: Object $data String $event String $action</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Implements the data to the object's attributes</p> |
| get\_log\_line      | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: String</p><p><strong>Description</strong>: Returns a string to be logged</p>                                                        |
| get\_relative\_path | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: String</p><p><strong>Description</strong>: Returns the path to which data must be logged</p>                                        |
| log                 | <p><strong>Arg</strong>: Object $data, String $event, String $action</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Parses the object and logs it</p>                |

#### Error Handler interface

This interface declares a single method that must be implemented by Error Handlers.

| Method              | Args, Returns, and Descriptions                                                                                                                                                 |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| set\_data           | <p><strong>Arg</strong>: <code>Throwable</code> $exception</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Sets the data to the object's attributes</p> |
| get\_log\_line      | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: String </p><p><strong>Description</strong>: Returns a string to be logged</p>                                         |
| get\_relative\_path | <p><strong>Arg</strong>: -</p><p><strong>Return</strong>: String </p><p><strong>Description</strong>: Returns the path to which data must be logged</p>                         |
| log                 | <p><strong>Arg</strong>: <code>Throwable</code> $exception</p><p><strong>Return</strong>: void</p><p><strong>Description</strong>: Parses the error object and logs it</p>      |

### Handler classes

The following table describes the Handler classes:

| Handler class   | Description                                                                                                                      |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| OrderHandler    | Stores order related logs to `orders/{order_id}.log`                                                                             |
| ProductHandler  | Stores product-related logs to `products/{product_id}.log`                                                                       |
| CheckoutHandler | Stores checkout-related logs to `checkouts/{checkout_id}.log`                                                                    |
| CustomerHandler | Stores customer-related logs to `customers/{customer_id}.log`                                                                    |
| SourceHandler   | Stores source related logs to `sources/{source_id}.log`                                                                          |
| GenericHandler  | Acts as a fallback and logs all the objects that are not handled by any other Handlers and writes them to the `default.log` file |
| ErrorHandler    | Logs any errors that arise to the `errors.log` file                                                                              |