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
impl BetterStackQuery
Sourcepub async fn query_raw(
&self,
sql: &str,
params: &QueryParams,
opts: &QueryOptions,
) -> Result<String>
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).
Sourcepub async fn query(
&self,
sql: &str,
params: &QueryParams,
opts: &QueryOptions,
) -> Result<Vec<QueryRow>>
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?;Sourcepub fn render_search_sql(&self, opts: &SearchLogsOptions) -> Result<String>
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.
Sourcepub async fn search_logs(
&self,
opts: SearchLogsOptions,
) -> Result<LogSearchResult>
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.
Sourcepub async fn search_logs_with(
&self,
opts: SearchLogsOptions,
query_opts: &QueryOptions,
) -> Result<LogSearchResult>
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
impl Clone for BetterStackQuery
Source§impl Debug for BetterStackQuery
impl Debug for BetterStackQuery
Source§impl LogQueryClient for BetterStackQuery
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,
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,
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,
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,
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,
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,
search until a record matches; see wait_for_log.