Package codes.grow.packages.loki
Class LogQL
java.lang.Object
codes.grow.packages.loki.LogQL
Immutable LogQL query builder with safe escaping. Every method returns a new builder.
LogQL.selector(Map.of("app", "x")).lineContains("err").json().where("status", ">=", 500).build()
// {app="x"} |= "err" | json | status >= 500
String literals are double-quoted with Go/JSON escaping (verified against Loki 3.7).
-
Method Summary
Modifier and TypeMethodDescriptionbuild()Renders the query.json()Parser stage| json.Adds a stream-selector matcher.lineContains(String text) Line filter|= "text"(case-sensitive substring).lineFormat(String template) Formatting stage| line_format "<template>".lineMatches(String regex) Line filter|~ "regex"(RE2; prefix(?i)for case-insensitive).lineNotContains(String text) Line filter!= "text".lineNotMatches(String regex) Line filter!~ "regex".logfmt()Parser stage| logfmt.Parser stage| pattern "<pattern>".Appends a raw pipeline stage (| <stage>), e.g.static StringQuotes a LogQL string literal with Go/JSON escaping (",\, control characters); other Unicode stays as is.Parser stage| regexp "<re>"with named capture groups.static LogQLStarts a query from equality matchers ({app="x", env="prod"}, names sorted).toString()Same asbuild().unpack()Parser stage| unpack.Numeric label filter with==,!=,>,>=,<,<=.Label filter on an extracted label or structured-metadata key, comparing strings with=,!=,=~,!~.
-
Method Details
-
selector
Starts a query from equality matchers ({app="x", env="prod"}, names sorted).- Parameters:
labels- label name → value- Returns:
- the builder
-
quote
Quotes a LogQL string literal with Go/JSON escaping (",\, control characters); other Unicode stays as is.- Parameters:
value- text- Returns:
- the quoted literal
-
label
Adds a stream-selector matcher.- Parameters:
name- label nameop-=,!=,=~or!~value- value or RE2 regex- Returns:
- a new builder
-
lineContains
Line filter|= "text"(case-sensitive substring).- Parameters:
text- text- Returns:
- a new builder
-
lineNotContains
Line filter!= "text".- Parameters:
text- text- Returns:
- a new builder
-
lineMatches
Line filter|~ "regex"(RE2; prefix(?i)for case-insensitive).- Parameters:
regex- regex- Returns:
- a new builder
-
lineNotMatches
Line filter!~ "regex".- Parameters:
regex- regex- Returns:
- a new builder
-
json
Parser stage| json.- Returns:
- a new builder
-
logfmt
Parser stage| logfmt.- Returns:
- a new builder
-
unpack
Parser stage| unpack.- Returns:
- a new builder
-
regexp
Parser stage| regexp "<re>"with named capture groups.- Parameters:
pattern- RE2 pattern- Returns:
- a new builder
-
pattern
Parser stage| pattern "<pattern>".- Parameters:
pattern- pattern expression- Returns:
- a new builder
-
lineFormat
Formatting stage| line_format "<template>".- Parameters:
template- Go template- Returns:
- a new builder
-
where
Label filter on an extracted label or structured-metadata key, comparing strings with=,!=,=~,!~.- Parameters:
field- label nameop- operatorvalue- value- Returns:
- a new builder
-
where
Numeric label filter with==,!=,>,>=,<,<=.- Parameters:
field- label nameop- operatorvalue- finite number- Returns:
- a new builder
-
pipe
Appends a raw pipeline stage (| <stage>), e.g.drop level.- Parameters:
stage- stage text without the leading pipe- Returns:
- a new builder
-
build
Renders the query.- Returns:
- LogQL text
- Throws:
ValidationException- when the selector is empty or every matcher also matches the empty value (Loki rejects such selectors)
-
toString
Same asbuild().
-