Skip to content

Commit

Permalink
linting
Browse files Browse the repository at this point in the history
Signed-off-by: alexmerlin <[email protected]>
  • Loading branch information
alexmerlin committed Feb 19, 2025
1 parent bb4ebb4 commit ef9a6dc
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/book/v4/extra/cookie.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Looking at `dot-errorhandler`'s config file, the array found at `CookieProvider::class` allows you to configure the behaviour of this provider:

- **enabled**: enabled/disable this provider
- **processor**: an array configuring the data processor to be used by the **CookieProvider**:
- **class**: data processor class implementing `Dot\ErrorHandler\Extra\Processor\ProcessorInterface`
- **replacementStrategy**: whether to replace specific cookie values completely or partially
- **sensitiveParameters**: an array of cookies names that may contain sensitive information so their value should be masked partially/completely
* **enabled**: enabled/disable this provider
* **processor**: an array configuring the data processor to be used by the **CookieProvider**:
* **class**: data processor class implementing `Dot\ErrorHandler\Extra\Processor\ProcessorInterface`

Check failure on line 7 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

Check failure on line 7 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]
* **replacementStrategy**: whether to replace specific cookie values completely or partially

Check failure on line 8 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

Check failure on line 8 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]
* **sensitiveParameters**: an array of cookies names that may contain sensitive information so their value should be masked partially/completely

Check failure on line 9 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

Check failure on line 9 in docs/book/v4/extra/cookie.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

## Configure provider

Expand Down
16 changes: 8 additions & 8 deletions docs/book/v4/log-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ By default, log activities are formatted with JSON, so each row should be a deco

Each row in a log file should contain the following values:

- **timestamp**: string representation of the date and time when the error occurred
- **priority**: numeric representation of the error level
- **priorityName**: string representation of the error level
- **message**: error message describing the error
- **extra**: an array of extra information that may help the developer debug the error:
- **file**: the file in which the error occurred
- **line**: the line from **file** where the error occurred
* **timestamp**: string representation of the date and time when the error occurred
* **priority**: numeric representation of the error level
* **priorityName**: string representation of the error level
* **message**: error message describing the error
* **extra**: an array of extra information that may help the developer debug the error:
* **file**: the file in which the error occurred

Check failure on line 17 in docs/book/v4/log-files.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

Check failure on line 17 in docs/book/v4/log-files.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]
* **line**: the line from **file** where the error occurred

Check failure on line 18 in docs/book/v4/log-files.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

Check failure on line 18 in docs/book/v4/log-files.md

View workflow job for this annotation

GitHub Actions / ci / QA Checks (Documentation Linting [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integra...

Unordered list indentation [Expected: 4; Actual: 2]

By leveraging `dot-errorhandler`'s extra providers, you can also log additional request parameters.
Learn more about what additional parameters are available on the [extra data](extra-data.md) page.
Learn more about what additional parameters are available on the [extra data](extra/introduction.md) page.

0 comments on commit ef9a6dc

Please sign in to comment.