Skip to main content

BetterStackQuery

Struct BetterStackQuery 

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

SQL query client for Better Stack Logs (ClickHouse HTTP interface with the connection’s own Basic credentials). Implements LogQueryClient: search runs search_logs on the configured source_table, tail polls search, list_streams returns the configured collection and list_labels is UNSUPPORTED (Better Stack has no labels). Cheap to clone.

Implementations§

Source§

impl BetterStackQuery

Source

pub async fn query_raw( &self, sql: &str, params: &QueryParams, opts: &QueryOptions, ) -> Result<String>

Runs SQL and returns the response text unchanged. params are bound server side ({name:Type} placeholders + param_<name> URL parameters).

Source

pub async fn query( &self, sql: &str, params: &QueryParams, opts: &QueryOptions, ) -> Result<Vec<QueryRow>>

Runs SQL and returns the rows. Without a FORMAT clause, FORMAT JSONEachRow is appended; FORMAT JSON / JSONEachRow (also with output_format_json_array_of_rows) are parsed, other formats are a VALIDATION error (use query_raw). A ClickHouse exception appended to a 200 response is returned as the mapped error.

use grow_better_stack_logs::{query_params, QueryOptions};
let rows = q
    .query(
        "SELECT count() AS c FROM remote(t1_app_logs) WHERE position(raw, {needle:String}) > 0",
        &query_params! { "needle" => "checkout" },
        &QueryOptions::default(),
    )
    .await?;
Source

pub fn render_search_sql(&self, opts: &SearchLogsOptions) -> Result<String>

Renders the search_logs SQL: hot remote(<source>_logs) UNION ALL cold s3Cluster(primary, <source>_s3), values as escaped literals, toDateTime64(…, 6, 'UTC') window, position(raw, …) substring match, LIMIT n+1.

Source

pub async fn search_logs( &self, opts: SearchLogsOptions, ) -> Result<LogSearchResult>

Searches hot and cold logs of a collection: inclusive time window, literal substring match, newest first by default. Rows are normalized (log_record_from_row) and deduplicated on (dt, raw); next_cursor is set when more rows exist.

Source

pub async fn search_logs_with( &self, opts: SearchLogsOptions, query_opts: &QueryOptions, ) -> Result<LogSearchResult>

search_logs with query options (settings, cancellation).

Trait Implementations§

Source§

impl Clone for BetterStackQuery

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 BetterStackQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl LogQueryClient for BetterStackQuery

Source§

fn search<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, opts: SearchOptions, ) -> Pin<Box<dyn Future<Output = Result<LogSearchResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

query is the contains text, searched in the configured source_table.

Source§

fn tail<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, on_record: RecordCallback, opts: TailOptions, ) -> Pin<Box<dyn Future<Output = Result<TailHandle>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Polls search oldest-first (Better Stack has no public streaming endpoint); stopped by the handle or by the client’s close.

Source§

fn list_streams<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The configured collections ([source_table], or []); Better Stack has no data-plane listing.

Source§

fn list_labels<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Always UNSUPPORTED: Better Stack has no label concept.

Source§

fn wait_for_log<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, opts: WaitOptions, ) -> Pin<Box<dyn Future<Output = Result<LogRecord>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Polls search until a record matches; see wait_for_log.

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