OpenSearch Log Query Go SDK
Constructor#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
var options []log.Option
log.OpenSearchLogQuery(`source=otel-logs-* | where severityText='ERROR'`, options...)Need to provide the query expression and a list of options. The expression is PPL unless QueryLanguage says otherwise. It cannot be empty, except for a Lucene query, where a blank expression matches every document.
Default options#
- Query(): with the expression provided in the constructor.
Available options#
Query#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.Query(`source=otel-logs-* | where severityText='ERROR' | head 20`)Define the query expression for log data, in the language set by QueryLanguage.
Datasource#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.Datasource("MyOpenSearchDatasource")Define the datasource the query will use.
Index#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.Index("otel-logs-*")Define the index or index pattern to read from. Required for the lucene and dsl languages, where it is the index in POST /{index}/_search. For PPL it is prepended to the query as a source=<index> clause, and ignored when the query already starts with source=. Ignored for SQL, which reads its index from the FROM clause.
QueryLanguage#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.QueryLanguage("lucene")Select how the query expression is interpreted: ppl, sql, lucene or dsl. When not set, the query is PPL and queryLanguage is omitted from the spec.
Limit#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.Limit(200)Cap the number of log documents fetched by a lucene or dsl query (the _search request's size). Must be between 1 and log.MaxLimit (10,000); defaults to 500 when not set. A size in a dsl body is capped at this value. Ignored for PPL and SQL.
TimestampField#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.TimestampField("time")Override which column carries the log timestamp, for indices that do not use @timestamp, timestamp or time. This is also the column used by the automatic time filter, which defaults to @timestamp.
MessageField#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.MessageField("msg")Override which column becomes the log line, for indices that do not use message, log or body.
DisableTimeFilter#
import "github.com/perses/plugins/opensearch/sdk/go/query/log"
log.DisableTimeFilter(true)Stop the panel time range from being added as a filter on the timestamp field, so the query manages its own time bounds.
Example#
package main
import (
"github.com/perses/perses/go-sdk/dashboard"
"github.com/perses/perses/go-sdk/panel"
panelgroup "github.com/perses/perses/go-sdk/panel-group"
logstable "github.com/perses/plugins/logstable/sdk/go"
osLog "github.com/perses/plugins/opensearch/sdk/go/query/log"
)
func main() {
dashboard.New("OpenSearch Dashboard",
dashboard.AddPanelGroup("Application Logs",
panelgroup.AddPanel("Error Logs",
logstable.LogsTable(),
panel.AddQuery(
osLog.OpenSearchLogQuery(`where severityText='ERROR' | head 100`,
osLog.Index("otel-logs-*"),
),
),
),
),
)
}
