Skip to main content

BetterStackConfig

Struct BetterStackConfig 

Source
pub struct BetterStackConfig { /* private fields */ }
Expand description

Immutable client configuration; build it with BetterStackConfig::builder or BetterStackConfig::from_env. Debug output redacts every credential.

Implementations§

Source§

impl BetterStackConfig

Source

pub fn builder() -> BetterStackConfigBuilder

A builder with nothing set.

Source

pub fn from_env() -> Result<Self>

Configuration from the process environment (explicit > GROW_BETTER_STACK_LOGS_* > vendor variables > defaults).

Source

pub fn common(&self) -> &CommonConfig

Settings shared by every Grow Codes SDK; the URL is the ingest URL, or the query URL for a query-only client.

Source

pub fn ingest_common(&self) -> Option<&CommonConfig>

Common settings of the ingest transport (None without ingest credentials).

Source

pub fn query_common(&self) -> Option<&CommonConfig>

Common settings of the SQL query transport (None without query credentials).

Source

pub fn url(&self) -> Option<&Url>

Ingest base URL (the source’s ingesting host), or None for a query-only client.

Source

pub fn source_token(&self) -> Option<&Secret>

Source token for the ingesting host.

Source

pub fn query_url(&self) -> Option<&Url>

SQL query base URL (ClickHouse HTTP interface).

Source

pub fn query_username(&self) -> Option<&str>

SQL connection username.

Source

pub fn query_password(&self) -> Option<&Secret>

SQL connection password.

Source

pub fn source_table(&self) -> Option<&str>

Default collection (t1234_myapp) used by search, search_logs, tail and ping.

Source

pub fn encoding(&self) -> Encoding

Ingest wire encoding (default Encoding::Json).

Source

pub fn has_ingest(&self) -> bool

Whether the ingest side (url + source token) is configured.

Source

pub fn has_query(&self) -> bool

Whether the SQL query side (query url + username + password) is configured.

Source

pub fn basic_credentials(&self) -> Option<Secret>

base64(username:password) for HTTP Basic, or None without query credentials.

Source

pub fn known_secrets(&self) -> Vec<Secret>

Credential values to redact from error messages and logs.

Source

pub fn validate(&self) -> Result<()>

Checks the service rules: each credential set is all-or-nothing, at least one is complete, source_table is an identifier and credentials are not blank.

Trait Implementations§

Source§

impl Clone for BetterStackConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BetterStackConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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