Skip to content

feat: unify config keys under the audit_http_client_ prefix #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ernolf merged 1 commit into from
Jul 17, 2026
Merged

feat: unify config keys under the audit_http_client_ prefix #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Nextcloud app that logs all outgoing HTTP requests made by Nextcloud's built-in

All settings are optional.

### `logdir_audit_http_client`
### `audit_http_client_logdir`

Explicit override for the log directory. Takes precedence over everything else.

```php
'logdir_audit_http_client' => '/var/log/nextcloud/http_client',
'audit_http_client_logdir' => '/var/log/nextcloud/http_client',
```

If this key is absent, the log directory is derived automatically:
Expand All @@ -36,7 +36,7 @@ If this key is absent, the log directory is derived automatically:

The directory is created automatically on first use.

### `loglevel_audit_http_client`
### `audit_http_client_loglevel`

Controls which responses are logged. Default: `0`.

Expand All @@ -49,10 +49,10 @@ Controls which responses are logged. Default: `0`.
Network errors (connection failures, DNS failures, etc.) are always logged regardless of this setting.

```php
'loglevel_audit_http_client' => 1,
'audit_http_client_loglevel' => 1,
```

### `audit_http_client_logs`
### `audit_http_client_format`

Selects the log output format. Default: `'both'`.

Expand All @@ -69,15 +69,15 @@ a3f9bc 2026-05-05T14:23:01+00:00 GET https://example.com/feed HTTP/2 200 compres
```

```php
'audit_http_client_logs' => 'json',
'audit_http_client_format' => 'json',
```

### `audit_http_client_logs_exclude_domain`
### `audit_http_client_exclude_domains`

List of hostnames to exclude from logging. Requests to matching hosts are passed through without any log entry. Matching is case-insensitive. Wildcard prefix (`*.example.com`) is supported and also matches the bare domain (`example.com`). Default: `[]`.

```php
'audit_http_client_logs_exclude_domain' => [
'audit_http_client_exclude_domains' => [
'apps.nextcloud.com',
'updates.nextcloud.com',
'*.googleapis.com',
Expand Down
8 changes: 4 additions & 4 deletions lib/Http/Client/LoggingClientService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ public function newClient(?callable $handler = null): IClient {
new HttpClientLoggerMiddleware(
$this->logger,
$this->resolveLogDir(),
(int)$this->config->getSystemValue('loglevel_audit_http_client', 0),
$this->config->getSystemValueString('audit_http_client_logs', 'both'),
(array)$this->config->getSystemValue('audit_http_client_logs_exclude_domain', []),
(int)$this->config->getSystemValue('audit_http_client_loglevel', 0),
$this->config->getSystemValueString('audit_http_client_format', 'both'),
(array)$this->config->getSystemValue('audit_http_client_exclude_domains', []),
(array)$this->config->getSystemValue('audit_http_client_redact_headers', []),
$this->request->getId(),
),
Expand All @@ -65,7 +65,7 @@ public function newClient(?callable $handler = null): IClient {
}

private function resolveLogDir(): string {
$explicit = $this->config->getSystemValueString('logdir_audit_http_client', '');
$explicit = $this->config->getSystemValueString('audit_http_client_logdir', '');
if ($explicit !== '') {
return rtrim($explicit, '/');
}
Expand Down
Loading