# shipperhq/module-logger

> ShipperHQ Logger

`composer require shipperhq/module-logger`

Canonical URL: https://packagento.com/shipperhq/module-logger

## At a glance

- **Vendor**: shipperhq (https://packagento.com/shipperhq.md)
- **Latest version**: 20.7.2 — released 2026-05-29
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/shipperhq/module-logger and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require shipperhq/module-logger:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

ShipperHQ Logger

## README

ShipperHQ Logger provides advanced, granular logging for Magento 2. It gives merchants and developers visibility into ShipperHQ's behaviour at checkout, with graded log levels, per-module filtering, and a built-in admin panel log viewer.

---

### Features

- **Graded Log Levels**: Log at debug, info, warning, and critical levels to capture exactly the detail you need.
- **Per-Module Logging**: Enable or disable logging granularly per ShipperHQ extension or module.
- **Log File Output**: Write log entries to specified log files for easy access and integration with external monitoring tools.
- **Admin Log Viewer**: View log entries directly from the Magento 2 admin panel without needing server access.

---

### Installation

Install using composer, you can find full instructions in the [ShipperHQ documentation](https://docs.shipperhq.com/installing-magento-2-shipperhq-extension/).

---

### Requirements

- Magento 2.4.4+
  - Compatibility with earlier editions is possible but not maintained
  - Supports both Magento Opensource (Community) and Magento Commerce (Enterprise)
- A valid ShipperHQ account. [Sign up here](https://shipperhq.com/) for your 15-day free trial!

---

### Configuration

**If you don't have a ShipperHQ account**:
1. Sign up for a free 15-day trial at www.shipperhq.com
2. You can then follow the steps the basic configuration wizard will guide you through

**Enable and configure logging**:
1. **API Credentials**:
    - Log in to your ShipperHQ account.
    - Navigate to `Websites` and find your API key and generate an Authentication Code.
    - Paste the key and code into the plugin settings under `Stores > Configuration > Sales > Shipping Methods > ShipperHQ`.
    - Set the `Enabled` dropdown to `Yes`.
    - Save the store configuration settings.

2. **Logger Settings**:
    - Navigate to the ShipperHQ Logger configuration in your Magento admin panel.
    - Set the desired log level and enable logging for the modules you want to monitor.
    - You can find detailed setup guides in our [documentation](https://docs.shipperhq.com/).

3. **View Logs**:
    - Log entries can be viewed from the admin panel log viewer or from the configured log files on your server.

---

### Frequently Asked Questions

#### 1. Do I need a ShipperHQ account to use this module?
Yes, an active ShipperHQ account is required to use this module.

#### 2. Is there a free trial available for ShipperHQ?
Yes, ShipperHQ offers a free trial for new users. You can sign up for the trial on the [ShipperHQ website](https://shipperhq.com/) and explore the platform's features before committing to a subscription.

#### 3. How do I troubleshoot missing log entries?
- Verify that the Logger module is enabled and the correct log level is configured.
- Ensure file write permissions are set correctly for the configured log file path.
- Check our extensive [documentation](https://docs.shipperhq.com/category/troubleshooting/) for troubleshooting tips.

#### 4. Can I log only specific ShipperHQ modules?
Yes, logging can be enabled or disabled per module in the Logger configuration, allowing you to focus on the areas most relevant to your investigation.

---

### Support

For assistance, please visit our [Help Center](https://docs.shipperhq.com/) or contact ShipperHQ support at [support@shipperhq.com](mailto:support@shipperhq.com).

For alternative contact methods, please visit our [Contact Us](https://shipperhq.com/contact/) page.

---

### Contributing

Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).

---

### License

See license files

---

### Copyright
Copyright (c) 2016 Zowta LLC (http://www.ShipperHQ.com)

## Changelog

### 20.4.0 (2018-06-21)
SHQ18-331 remove module-common dependency


### 20.5.0 (2020-09-17)
MNB-657 Remove logging per extension switches


### 20.6.0 (2022-02-18)
MNB-5 Move to declarative schema


### 20.7.0 (2022-05-13)
MNB-2430 M2.4.4 compatibility


### 20.7.1 (2024-06-27)
SHQ23-1281 Fix security linter warnings


### 20.7.2 (2026-05-29)
ENG26-26 Modernise copyrights and namespaces. Update readme

## Recent Versions

| Version | Released |
|---|---|
| 20.7.2 | 2026-05-29 |
| 20.7.1 | 2024-06-27 |
| 20.7.0 | 2022-05-13 |
| 20.6.0 | 2022-02-18 |
| 20.5.0 | 2020-09-17 |
| 20.4.0 | 2018-06-21 |
| 20.3.3 | 2018-05-18 |
| 20.3.2 | 2018-04-13 |
| 20.3.1 | 2018-04-03 |
| 20.3.0 | 2018-04-03 |

Showing 10 of 24 versions. Full release history on https://packagento.com/shipperhq/module-logger.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=100.0 |

## Quality

Latest release (20.7.2) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 74 | 1 error, 73 warnings (ruleset: Magento2) — 25 auto-fixable with phpcbf |
| PHPMD | Warning | 16 | 16 rule violations (UnusedFormalParameter:6, IfStatementAssignment:2, UndefinedVariable:2, CyclomaticComplexity:2, MissingImport:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 50 | 50 | – | – |
| 2.4.8 | – | 51 | 51 | – |
| 2.4.9 | – | – | 50 | 50 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["shipperhq/module-logger"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

shipperhq is a Magento 2 vendor on Packagento. See https://packagento.com/shipperhq.md for their full catalogue.