Skip to content
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.

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

Log documentation #310

Merged
merged 23 commits into from
Sep 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Unreleased changes are available as `avenga/couper:edge` container.

* **Added**
* `Accept: application/json` request header to the OAuth2 token request, in order to make the Github token endpoint respond with a JSON token response ([#307](https://github.com/avenga/couper/pull/307))
* Documentation of [logs](docs/LOGS.md) ([#310](https://github.com/avenga/couper/pull/310))

* **Changed**
* Organized log format fields for uniform access and upstream log ([#300](https://github.com/avenga/couper/pull/300))
Expand Down
18 changes: 9 additions & 9 deletions docs/CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ Couper is build as binary called `couper` with the following commands:

## Global Options

| Argument | Default | Environment | Description |
| :------------------- | :----------- | :------------------------- | :-------------------------------------------------------------------------------------- |
| `-f` | `couper.hcl` | `COUPER_FILE` | File path to your Couper configuration file. |
| `-watch` | `false` | `COUPER_WATCH` | Watch for configuration file changes and reload on modifications. |
| `-watch-retries` | `5` | `COUPER_WATCH_RETRIES` | Maximal retry count for configuration reloads which could not bind the configured port. |
| `-watch-retry-delay` | `500ms` | `COUPER_WATCH_RETRY_DELAY` | Delay duration before next attempt if an error occurs. |
| `-log-format` | `common` | `COUPER_LOG_FORMAT` | Can be set to `json` output format. |
| Argument | Default | Environment | Description |
| :------------------- | :----------- | :------------------------- | :---------------------------------------------------------------------------------------- |
| `-f` | `couper.hcl` | `COUPER_FILE` | File path to your Couper configuration file. |
| `-watch` | `false` | `COUPER_WATCH` | Watch for configuration file changes and reload on modifications. |
| `-watch-retries` | `5` | `COUPER_WATCH_RETRIES` | Maximum retry count for configuration reloads which could not bind the configured port. |
| `-watch-retry-delay` | `500ms` | `COUPER_WATCH_RETRY_DELAY` | Delay duration before next attempt if an error occurs. |
| `-log-format` | `common` | `COUPER_LOG_FORMAT` | Can be set to `json` output format. |
| `-log-level` | `info` | `COUPER_LOG_LEVEL` | Set the log-level to one of: `info`, `panic`, `fatal`, `error`, `warn`, `debug`, `trace`. |
| `-log-pretty` | `false` | `COUPER_LOG_PRETTY` | Option for `json` log format which pretty prints with basic key coloring. |
| `-log-pretty` | `false` | `COUPER_LOG_PRETTY` | Option for `json` log format which pretty prints with basic key coloring. |

_Note_: `log-format` and `log-pretty` also maps to [settings](REFERENCE.md#settings-block).
_Note_: `log-format`, `log-level` and `log-pretty` also map to [settings](REFERENCE.md#settings-block).

## Run Options

Expand Down
Loading