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.

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

Jump to bottom

Make it easier to find information about the logging levels in logging.md #1852

Closed
wants to merge 2 commits into from
Closed

Make it easier to find information about the logging levels in logging.md #1852

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a99eb33
Improve info/links about logging levels
MiriPii Mar 26, 2024
0461e06
Add a link to example config
MiriPii Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/logging.md
View file
Open in desktop
Expand Up @@ -77,6 +77,8 @@ if the environment variable is set, the configuration key `log.file` will not ha
RabbitMQ starts logging early on node start. See the [Configuration guide](./configure)
for a general overview of how to configure RabbitMQ.

The full list of available configuration options can be found in the [example rabbitmq.conf -file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example).
Copy link
Member

Choose a reason for hiding this comment

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

Could you please remove the "-" before "file"? Our Doc writer is unavailable right now to confirm but we don't use this anywhere in the docs AFAIK.

Copy link
Member

Choose a reason for hiding this comment

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

We don't need to mention that it is a file, it should be obvious to the reader.

Copy link
Member

Choose a reason for hiding this comment

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

I don't see why we need to link to this example file from this guide, given that we already link to the configuration guide.


### Logging to a File {#logging-to-a-file}

Logging to a file is one of the most common options for RabbitMQ installations. In modern releases,
Expand Down Expand Up @@ -107,7 +109,7 @@ The following example instructs RabbitMQ to log to a file at the `debug` level:
log.file.level = debug
```

Supported log levels ca be found in the [example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example).
> Supported log levels are discussed in the [Log Levels -section](#log-levels) found below.
Copy link
Member

Choose a reason for hiding this comment

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

Likewise, could you please remove the "-" before "section"?


Logging to a file can be deactivated with

Expand Down Expand Up @@ -217,7 +219,7 @@ The following example instructs RabbitMQ to use the `debug` logging level when l
log.console.level = debug
```

Supported log levels ca be found in the [example rabbitmq.conf file](https://github.com/rabbitmq/rabbitmq-server/blob/v3.13.x/deps/rabbit/docs/rabbitmq.conf.example).
> Supported log levels are discussed in the [Log Levels -section](#log-levels) found below.
Copy link
Member

Choose a reason for hiding this comment

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

Likewise, could you please remove the "-" before "section"?


Logging to console in JSON format:

Expand Down