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

PBM-1226 Documented custom log path configuration #235

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

nastena1606
Copy link
Collaborator

new file:   docs/manage/logpath.md
modified:   mkdocs-base.yml

	new file:   docs/manage/logpath.md
	modified:   mkdocs-base.yml
docs/manage/logpath.md Outdated Show resolved Hide resolved
docs/manage/logpath.md Outdated Show resolved Hide resolved
docs/manage/logpath.md Outdated Show resolved Hide resolved
Co-authored-by: Sandra Romanchenko <[email protected]>
@it-percona it-percona temporarily deployed to PBM-1226-Doc-custom-logpath - pbm-docs PR #235 December 3, 2024 10:23 — with Render Destroyed
Co-authored-by: Sandra Romanchenko <[email protected]>
@it-percona it-percona temporarily deployed to PBM-1226-Doc-custom-logpath - pbm-docs PR #235 December 3, 2024 10:24 — with Render Destroyed
Co-authored-by: Sandra Romanchenko <[email protected]>
@it-percona it-percona temporarily deployed to PBM-1226-Doc-custom-logpath - pbm-docs PR #235 December 3, 2024 10:24 — with Render Destroyed
docs/manage/logpath.md Outdated Show resolved Hide resolved
Copy link
Member

@boris-ilijic boris-ilijic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with description, but please see comments.

| Environment variable | Command line flag | Description |
|----------------------|-------------------|-------------|
| `LOG_PATH` | `--log-path` | The path to the log file. The file is created if it doesn't exist. The default value is `/dev/stderr` which means that the logs are written to the standard error output. |
| `LOG_LEVEL` | `--log-level` | The log severity level. Supported levels are (from low to high): D - Debug, I - Info (default), W - Warning, E - Error, F - Fatal.<br><br> The output includes both the specified severity level and all higher ones |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `LOG_LEVEL` | `--log-level` | The log severity level. Supported levels are (from low to high): D - Debug, I - Info (default), W - Warning, E - Error, F - Fatal.<br><br> The output includes both the specified severity level and all higher ones |
| `LOG_LEVEL` | `--log-level` | The log severity level. Supported levels are (from low to high): D - Debug (default), I - Info, W - Warning, E - Error, F - Fatal.<br><br> The output includes both the specified severity level and all higher ones |

Debug is default.

|----------------------|-------------------|-------------|
| `LOG_PATH` | `--log-path` | The path to the log file. The file is created if it doesn't exist. The default value is `/dev/stderr` which means that the logs are written to the standard error output. |
| `LOG_LEVEL` | `--log-level` | The log severity level. Supported levels are (from low to high): D - Debug, I - Info (default), W - Warning, E - Error, F - Fatal.<br><br> The output includes both the specified severity level and all higher ones |
| `LOG_OUTPUT`| `--log-output` | The output format of the log messages. Supported values are `text` (default) and `json`. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `LOG_OUTPUT`| `--log-output` | The output format of the log messages. Supported values are `text` (default) and `json`. |
| `LOG_JSON`| `--log-json` | The output format of the log messages. If specified `json` format is use and default is `text` format. |

=== ":material-console: Command line"

```{.bash data-prompt="$"}
$ pbm-agent --log-path=/var/log/pbm-agent.log --log-level=W --log-output=json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ pbm-agent --log-path=/var/log/pbm-agent.log --log-level=W --log-output=json
$ pbm-agent --log-path=/var/log/pbm-agent.log --log-level=W --log-json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants