Struct merino_settings::Settings

source · [−]

pub struct Settings {Show 14 fields
    pub env: String,
    pub debug: bool,
    pub http: HttpSettings,
    pub provider_settings: ProviderSettings,
    pub suggestion_providers: HashMap<String, SuggestionProviderConfig>,
    pub logging: LoggingSettings,
    pub metrics: MetricsSettings,
    pub sentry: SentrySettings,
    pub public_documentation: Option<Uri>,
    pub redis: RedisSettings,
    pub remote_settings: RemoteSettingsGlobalSettings,
    pub location: LocationSettings,
    pub log_full_request: bool,
    pub elasticsearch: ElasticsearchSettings,
}

Expand description

Top level settings object for Merino.

Fields

env: String

The environment Merino is running in. Should only be set with the MERINO__ENV environment variable.

debug: bool

Enable additional features to debug the application. This should not be set to true in production environments.

http: HttpSettings

Settings for the HTTP server.

provider_settings: ProviderSettings

Settings for the suggestion providers

suggestion_providers: HashMap<String, SuggestionProviderConfig>

Providers to use to generate suggestions

logging: LoggingSettings

Logging settings.

metrics: MetricsSettings

Metrics settings.

sentry: SentrySettings

Settings for error reporting via Sentry.

public_documentation: Option<Uri>

URL to redirect curious users to, that explains what this service is. Preferable a public wiki page. Optional.

redis: RedisSettings

Settings for connecting to Redis.

remote_settings: RemoteSettingsGlobalSettings

Settings for connecting to Remote Settings.

location: LocationSettings

Settings to use when determining the location associated with requests.

log_full_request: bool

If on, log the entire suggestion request object as a part of the tracing log, including the search query. When the setting is off, the suggest request object should be logged, but the search query should be blank.

elasticsearch: ElasticsearchSettings

Implementations

impl Settings

pub async fn load() -> Result<Self>

Load settings from configuration files and environment variables.

Errors

If any of the configured values are invalid, or if any of the required configuration files are missing.

pub fn load_for_tests() -> Self

Load settings from configuration files for tests.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Settings

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Settings

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Settings

impl Send for Settings

impl Sync for Settings

impl Unpin for Settings

impl UnwindSafe for Settings

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,