Skip to content

LogsQueryBuilder🔗

Shape of a CloudWatch Logs query

Constructor🔗

func NewLogsQueryBuilder() *LogsQueryBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *LogsQueryBuilder) Build() (LogsQuery, error)

Datasource🔗

For mixed data sources the selected datasource is on the query level.

For non mixed scenarios this is undefined.

TODO find a better way to do this ^ that's friendly to schema

TODO this shouldn't be unknown but DataSourceRef | null

func (builder *LogsQueryBuilder) Datasource(datasource common.DataSourceRef) *LogsQueryBuilder

Expression🔗

The CloudWatch Logs Insights query to execute

func (builder *LogsQueryBuilder) Expression(expression string) *LogsQueryBuilder

Hide🔗

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

func (builder *LogsQueryBuilder) Hide(hide bool) *LogsQueryBuilder

Id🔗

func (builder *LogsQueryBuilder) Id(id string) *LogsQueryBuilder

LogGroupNames🔗

@deprecated use logGroups

func (builder *LogsQueryBuilder) LogGroupNames(logGroupNames []string) *LogsQueryBuilder

LogGroups🔗

Log groups to query

func (builder *LogsQueryBuilder) LogGroups(logGroups []cog.Builder[cloudwatch.LogGroup]) *LogsQueryBuilder

QueryLanguage🔗

Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.

func (builder *LogsQueryBuilder) QueryLanguage(queryLanguage cloudwatch.LogsQueryLanguage) *LogsQueryBuilder

QueryMode🔗

Whether a query is a Metrics, Logs, or Annotations query

func (builder *LogsQueryBuilder) QueryMode(queryMode cloudwatch.QueryMode) *LogsQueryBuilder

QueryType🔗

Specify the query flavor

TODO make this required and give it a default

func (builder *LogsQueryBuilder) QueryType(queryType string) *LogsQueryBuilder

RefId🔗

A unique identifier for the query within the list of targets.

In server side expressions, the refId is used as a variable name to identify results.

By default, the UI will assign A->Z; however setting meaningful names may be useful.

func (builder *LogsQueryBuilder) RefId(refId string) *LogsQueryBuilder

Region🔗

AWS region to query for the logs

func (builder *LogsQueryBuilder) Region(region string) *LogsQueryBuilder

StatsGroups🔗

Fields to group the results by, this field is automatically populated whenever the query is updated

func (builder *LogsQueryBuilder) StatsGroups(statsGroups []string) *LogsQueryBuilder

See also🔗