Clarify RUST_LOG override over LogSettings (#3095)

# Objective

Clarify the fact that setting the `RUST_LOG` environment variable
overrides any setting from the `LogSettings` resource.

## Solution

Update docstring comment for `LogSettings`.
This commit is contained in:
Jerome Humbert 2021-11-11 01:43:51 +00:00
parent 36394adb2f
commit 0db1f4cd16

View file

@ -45,6 +45,8 @@ use tracing_subscriber::{prelude::*, registry::Registry, EnvFilter};
/// ///
/// Log level can also be changed using the `RUST_LOG` environment variable. /// Log level can also be changed using the `RUST_LOG` environment variable.
/// It has the same syntax has the field [`LogSettings::filter`], see [`EnvFilter`]. /// It has the same syntax has the field [`LogSettings::filter`], see [`EnvFilter`].
/// If you define the `RUST_LOG` environment variable, the [`LogSettings`] resource
/// will be ignored.
/// ///
/// If you want to setup your own tracing collector, you should disable this /// If you want to setup your own tracing collector, you should disable this
/// plugin from `DefaultPlugins` with [`App::add_plugins_with`]: /// plugin from `DefaultPlugins` with [`App::add_plugins_with`]: