Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Expanding Query Types for creating "Query Result" dashboard variables #206

Merged
merged 3 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions custom/dashboard/variable.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,15 @@ local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet';
if metric == ''
then var.withQuery('label_values(%s)' % label)
else var.withQuery('label_values(%s, %s)' % [metric, label]),

'#withQueryResult':: d.func.new(
'Construct a Prometheus template variable using `query_result()`.',
args=[
d.arg('query', d.T.string),
]
),
withQueryResult(query):
var.withQuery('query_result(%s)' % query),
},

// Deliberately undocumented, use `refresh` below
Expand Down
12 changes: 12 additions & 0 deletions docs/API/dashboard/variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ g.dashboard.new('my dashboard')
* [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly)
* [`obj queryTypes`](#obj-queryquerytypes)
* [`fn withLabelValues(label, metric="")`](#fn-queryquerytypeswithlabelvalues)
* [`fn withQueryResult(query)`](#fn-queryquerytypeswithqueryresult)
* [`obj refresh`](#obj-queryrefresh)
* [`fn onLoad()`](#fn-queryrefreshonload)
* [`fn onTime()`](#fn-queryrefreshontime)
Expand Down Expand Up @@ -898,6 +899,17 @@ PARAMETERS:
- default value: `""`

Construct a Prometheus template variable using `label_values()`.
##### fn query.queryTypes.withQueryResult

```jsonnet
query.queryTypes.withQueryResult(query)
```

PARAMETERS:

* **query** (`string`)

Construct a Prometheus template variable using `query_result()`.
#### obj query.refresh


Expand Down
9 changes: 9 additions & 0 deletions gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions gen/grafonnet-v11.0.0/docs/dashboard/variable.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.