├── .flake8 ├── .github ├── dependabot.yaml └── workflows │ └── test.yaml ├── .gitignore ├── .pre-commit-config.yaml ├── .readthedocs.yaml ├── LICENSE ├── README.md ├── dashboards ├── activity.jsonnet ├── cluster.jsonnet ├── common.libsonnet ├── homedirs.jsonnet ├── jupyterhub.jsonnet ├── jupyterhub.libsonnet ├── support.jsonnet ├── usage-report.jsonnet └── user.jsonnet ├── demo.gif ├── deploy.py ├── docs ├── Makefile ├── conf.py ├── contributing.md ├── explanation │ └── index.md ├── howto │ ├── images.md │ ├── index.md │ └── user-diagnostics.md ├── index.md ├── make.bat ├── reference │ └── index.md ├── requirements.txt └── tutorials │ ├── deploy.md │ └── index.md ├── jsonnetfile.json ├── jsonnetfile.lock.json ├── noxfile.py ├── pyproject.toml └── vendor ├── doc-util ├── github.com ├── grafana │ └── grafonnet │ │ └── gen │ │ └── grafonnet-v11.1.0 │ │ ├── accesspolicy.libsonnet │ │ ├── alerting.libsonnet │ │ ├── clean │ │ └── alerting │ │ │ ├── contactPoint.libsonnet │ │ │ ├── muteTiming.libsonnet │ │ │ ├── notificationPolicy.libsonnet │ │ │ ├── notificationTemplate.libsonnet │ │ │ └── ruleGroup.libsonnet │ │ ├── custom │ │ ├── alerting │ │ │ ├── contactPoint.libsonnet │ │ │ ├── muteTiming.libsonnet │ │ │ ├── notificationPolicy.libsonnet │ │ │ └── ruleGroup.libsonnet │ │ ├── dashboard.libsonnet │ │ ├── dashboard │ │ │ ├── annotation.libsonnet │ │ │ ├── link.libsonnet │ │ │ └── variable.libsonnet │ │ ├── panel.libsonnet │ │ ├── query │ │ │ ├── azureMonitor.libsonnet │ │ │ ├── cloudWatch.libsonnet │ │ │ ├── elasticsearch.libsonnet │ │ │ ├── expr.libsonnet │ │ │ ├── googleCloudMonitoring.libsonnet │ │ │ ├── grafanaPyroscope.libsonnet │ │ │ ├── loki.libsonnet │ │ │ ├── parca.libsonnet │ │ │ ├── prometheus.libsonnet │ │ │ ├── tempo.libsonnet │ │ │ └── testData.libsonnet │ │ ├── row.libsonnet │ │ └── util │ │ │ ├── dashboard.libsonnet │ │ │ ├── grid.libsonnet │ │ │ ├── main.libsonnet │ │ │ ├── panel.libsonnet │ │ │ └── string.libsonnet │ │ ├── dashboard.libsonnet │ │ ├── docs │ │ ├── README.md │ │ ├── accesspolicy │ │ │ ├── index.md │ │ │ └── rules.md │ │ ├── alerting │ │ │ ├── contactPoint.md │ │ │ ├── index.md │ │ │ ├── muteTiming │ │ │ │ ├── index.md │ │ │ │ └── interval │ │ │ │ │ ├── index.md │ │ │ │ │ └── time_intervals │ │ │ │ │ ├── index.md │ │ │ │ │ └── times.md │ │ │ ├── notificationPolicy │ │ │ │ ├── index.md │ │ │ │ └── matcher.md │ │ │ ├── notificationTemplate.md │ │ │ └── ruleGroup │ │ │ │ ├── index.md │ │ │ │ └── rule │ │ │ │ ├── data.md │ │ │ │ └── index.md │ │ ├── dashboard │ │ │ ├── annotation.md │ │ │ ├── index.md │ │ │ ├── link.md │ │ │ └── variable.md │ │ ├── folder.md │ │ ├── librarypanel │ │ │ ├── index.md │ │ │ └── model │ │ │ │ ├── fieldConfig │ │ │ │ ├── defaults │ │ │ │ │ └── thresholds │ │ │ │ │ │ └── steps.md │ │ │ │ └── overrides │ │ │ │ │ ├── index.md │ │ │ │ │ └── properties.md │ │ │ │ ├── links.md │ │ │ │ └── transformations.md │ │ ├── panel │ │ │ ├── alertList │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── annotationsList │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── barChart │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── barGauge │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── candlestick │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── canvas │ │ │ │ ├── index.md │ │ │ │ ├── options │ │ │ │ │ └── root │ │ │ │ │ │ └── elements │ │ │ │ │ │ ├── connections │ │ │ │ │ │ ├── index.md │ │ │ │ │ │ └── vertices.md │ │ │ │ │ │ └── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── dashboardList │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── datagrid │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── debug │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── gauge │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── geomap │ │ │ │ ├── index.md │ │ │ │ ├── options │ │ │ │ │ └── layers.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── heatmap │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── histogram │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── index.md │ │ │ ├── logs │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── news │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── nodeGraph │ │ │ │ ├── index.md │ │ │ │ ├── options │ │ │ │ │ └── nodes │ │ │ │ │ │ └── arcs.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── pieChart │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── row.md │ │ │ ├── stat │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── stateTimeline │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── statusHistory │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── table │ │ │ │ ├── index.md │ │ │ │ ├── options │ │ │ │ │ └── sortBy.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── text │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── timeSeries │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ ├── trend │ │ │ │ ├── index.md │ │ │ │ ├── panelOptions │ │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ │ ├── mapping.md │ │ │ │ │ ├── override.md │ │ │ │ │ └── threshold │ │ │ │ │ └── step.md │ │ │ └── xyChart │ │ │ │ ├── index.md │ │ │ │ ├── options │ │ │ │ └── series.md │ │ │ │ ├── panelOptions │ │ │ │ └── link.md │ │ │ │ ├── queryOptions │ │ │ │ └── transformation.md │ │ │ │ └── standardOptions │ │ │ │ ├── mapping.md │ │ │ │ ├── override.md │ │ │ │ └── threshold │ │ │ │ └── step.md │ │ ├── preferences.md │ │ ├── publicdashboard.md │ │ ├── query │ │ │ ├── azureMonitor │ │ │ │ ├── azureMonitor │ │ │ │ │ ├── dimensionFilters.md │ │ │ │ │ └── resources.md │ │ │ │ ├── azureTraces │ │ │ │ │ └── filters.md │ │ │ │ └── index.md │ │ │ ├── cloudWatch │ │ │ │ ├── CloudWatchLogsQuery │ │ │ │ │ └── logGroups.md │ │ │ │ ├── CloudWatchMetricsQuery │ │ │ │ │ └── sql │ │ │ │ │ │ ├── from │ │ │ │ │ │ └── QueryEditorFunctionExpression │ │ │ │ │ │ │ └── parameters.md │ │ │ │ │ │ ├── orderBy │ │ │ │ │ │ └── parameters.md │ │ │ │ │ │ └── select │ │ │ │ │ │ └── parameters.md │ │ │ │ └── index.md │ │ │ ├── elasticsearch │ │ │ │ ├── bucketAggs │ │ │ │ │ ├── Filters │ │ │ │ │ │ └── settings │ │ │ │ │ │ │ └── filters.md │ │ │ │ │ └── index.md │ │ │ │ ├── index.md │ │ │ │ └── metrics │ │ │ │ │ ├── MetricAggregationWithSettings │ │ │ │ │ └── BucketScript │ │ │ │ │ │ └── pipelineVariables.md │ │ │ │ │ ├── PipelineMetricAggregation │ │ │ │ │ └── BucketScript │ │ │ │ │ │ └── pipelineVariables.md │ │ │ │ │ └── index.md │ │ │ ├── expr │ │ │ │ ├── TypeClassicConditions │ │ │ │ │ ├── conditions.md │ │ │ │ │ └── index.md │ │ │ │ ├── TypeMath.md │ │ │ │ ├── TypeReduce.md │ │ │ │ ├── TypeResample.md │ │ │ │ ├── TypeSql.md │ │ │ │ ├── TypeThreshold │ │ │ │ │ ├── conditions.md │ │ │ │ │ └── index.md │ │ │ │ └── index.md │ │ │ ├── googleCloudMonitoring.md │ │ │ ├── grafanaPyroscope.md │ │ │ ├── index.md │ │ │ ├── loki.md │ │ │ ├── parca.md │ │ │ ├── prometheus.md │ │ │ ├── tempo │ │ │ │ ├── filters.md │ │ │ │ ├── groupBy.md │ │ │ │ └── index.md │ │ │ └── testData │ │ │ │ ├── csvWave.md │ │ │ │ └── index.md │ │ ├── role.md │ │ ├── rolebinding.md │ │ ├── team.md │ │ └── util.md │ │ ├── folder.libsonnet │ │ ├── jsonnetfile.json │ │ ├── librarypanel.libsonnet │ │ ├── main.libsonnet │ │ ├── panel.libsonnet │ │ ├── panel │ │ ├── alertList.libsonnet │ │ ├── annotationsList.libsonnet │ │ ├── barChart.libsonnet │ │ ├── barGauge.libsonnet │ │ ├── candlestick.libsonnet │ │ ├── canvas.libsonnet │ │ ├── dashboardList.libsonnet │ │ ├── datagrid.libsonnet │ │ ├── debug.libsonnet │ │ ├── gauge.libsonnet │ │ ├── geomap.libsonnet │ │ ├── heatmap.libsonnet │ │ ├── histogram.libsonnet │ │ ├── logs.libsonnet │ │ ├── news.libsonnet │ │ ├── nodeGraph.libsonnet │ │ ├── pieChart.libsonnet │ │ ├── row.libsonnet │ │ ├── stat.libsonnet │ │ ├── stateTimeline.libsonnet │ │ ├── statusHistory.libsonnet │ │ ├── table.libsonnet │ │ ├── text.libsonnet │ │ ├── timeSeries.libsonnet │ │ ├── trend.libsonnet │ │ └── xyChart.libsonnet │ │ ├── panelindex.libsonnet │ │ ├── preferences.libsonnet │ │ ├── publicdashboard.libsonnet │ │ ├── query.libsonnet │ │ ├── query │ │ ├── azureMonitor.libsonnet │ │ ├── cloudWatch.libsonnet │ │ ├── elasticsearch.libsonnet │ │ ├── expr.libsonnet │ │ ├── googleCloudMonitoring.libsonnet │ │ ├── grafanaPyroscope.libsonnet │ │ ├── loki.libsonnet │ │ ├── parca.libsonnet │ │ ├── prometheus.libsonnet │ │ ├── tempo.libsonnet │ │ └── testData.libsonnet │ │ ├── role.libsonnet │ │ ├── rolebinding.libsonnet │ │ └── team.libsonnet └── jsonnet-libs │ ├── docsonnet │ └── doc-util │ │ ├── README.md │ │ ├── main.libsonnet │ │ └── render.libsonnet │ └── xtd │ ├── .github │ └── workflows │ │ └── tests.yml │ ├── .gitignore │ ├── LICENSE │ ├── Makefile │ ├── README.md │ ├── aggregate.libsonnet │ ├── array.libsonnet │ ├── ascii.libsonnet │ ├── camelcase.libsonnet │ ├── date.libsonnet │ ├── docs │ ├── .gitignore │ ├── Gemfile │ ├── README.md │ ├── _config.yml │ ├── aggregate.md │ ├── array.md │ ├── ascii.md │ ├── camelcase.md │ ├── date.md │ ├── inspect.md │ ├── jsonpath.md │ ├── number.md │ ├── string.md │ └── url.md │ ├── inspect.libsonnet │ ├── jsonpath.libsonnet │ ├── main.libsonnet │ ├── number.libsonnet │ ├── string.libsonnet │ ├── test │ ├── array_test.jsonnet │ ├── ascii_test.jsonnet │ ├── camelcase_test.jsonnet │ ├── date_test.jsonnet │ ├── inspect_test.jsonnet │ ├── jsonnetfile.json │ ├── jsonpath_test.jsonnet │ └── url_test.jsonnet │ └── url.libsonnet ├── grafonnet └── xtd /.flake8: -------------------------------------------------------------------------------- 1 | # flake8 is used for linting Python code setup to automatically run with 2 | # pre-commit. 3 | # 4 | # ref: https://flake8.pycqa.org/en/latest/user/configuration.html 5 | # 6 | 7 | [flake8] 8 | # E: style errors 9 | # W: style warnings 10 | # C: complexity 11 | # D: docstring warnings (unused pydocstyle extension) 12 | ignore = E, C, W, D 13 | -------------------------------------------------------------------------------- /.github/dependabot.yaml: -------------------------------------------------------------------------------- 1 | # dependabot.yaml reference: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file 2 | # 3 | # Notes: 4 | # - Status and logs from dependabot are provided at 5 | # https://github.com/jupyterhub/grafana-dashboards/network/updates. 6 | # 7 | version: 2 8 | updates: 9 | # Maintain dependencies in our GitHub Workflows 10 | - package-ecosystem: github-actions 11 | directory: / 12 | labels: [ci] 13 | schedule: 14 | interval: monthly 15 | time: "05:00" 16 | timezone: Etc/UTC 17 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | # This is a GitHub workflow defining a set of jobs with a set of steps. 2 | # ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions 3 | # 4 | name: Tests 5 | 6 | on: 7 | pull_request: 8 | paths-ignore: 9 | - "docs/**" 10 | - ".github/workflows/*.yaml" 11 | - "!.github/workflows/test.yaml" 12 | push: 13 | paths-ignore: 14 | - "docs/**" 15 | - ".github/workflows/*.yaml" 16 | - "!.github/workflows/test.yaml" 17 | branches-ignore: 18 | - "dependabot/**" 19 | - "pre-commit-ci-update-config" 20 | tags: ["**"] 21 | workflow_dispatch: 22 | 23 | jobs: 24 | render-dashboards: 25 | runs-on: ubuntu-22.04 26 | 27 | strategy: 28 | fail-fast: false 29 | matrix: 30 | jsonnet-version: ["0.20.0"] 31 | 32 | steps: 33 | - uses: actions/checkout@v4 34 | 35 | - name: Download jsonnet (go-jsonnet) 36 | run: | 37 | JSONNET_VERSION=${{ matrix.jsonnet-version }} 38 | wget -qO- https://github.com/google/go-jsonnet/releases/download/v${JSONNET_VERSION}/go-jsonnet_${JSONNET_VERSION}_Linux_x86_64.tar.gz \ 39 | | tar -xvz --one-top-level=$HOME/.local/bin 40 | 41 | - run: jsonnet --version 42 | 43 | - name: Render dashboards 44 | run: | 45 | mkdir rendered-dashboards 46 | dashboard_folders="dashboards" 47 | for file in `find $dashboard_folders -name '*.jsonnet'` 48 | do 49 | jsonnet -J vendor --output-file rendered-dashboards/`basename $file` $file 50 | done 51 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | rendered-dashboards 2 | 3 | # --- 4 | 5 | # Binaries for programs and plugins 6 | *.exe 7 | *.exe~ 8 | *.dll 9 | *.so 10 | *.dylib 11 | 12 | # Test binary, built with `go test -c` 13 | *.test 14 | 15 | # Output of the go coverage tool, specifically when used with LiteIDE 16 | *.out 17 | 18 | # Dependency directories (remove the comment below to include it) 19 | # vendor/ 20 | 21 | # Folders generated when building the documentation 22 | .nox/* 23 | docs/_build 24 | 25 | # Standard Python ignores 26 | __pycache__/ 27 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # Configuration on how ReadTheDocs (RTD) builds our documentation 2 | # ref: https://readthedocs.org/projects/jupyterhub-grafana/ 3 | # ref: https://docs.readthedocs.io/en/stable/config-file/v2.html 4 | # 5 | version: 2 6 | 7 | build: 8 | os: ubuntu-22.04 9 | tools: 10 | python: "3.11" 11 | 12 | sphinx: 13 | configuration: docs/conf.py 14 | 15 | python: 16 | install: 17 | - requirements: docs/requirements.txt 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 3-Clause License 2 | 3 | Copyright (c) 2020, Yuvi Panda 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without 7 | modification, are permitted provided that the following conditions are met: 8 | 9 | 1. Redistributions of source code must retain the above copyright notice, this 10 | list of conditions and the following disclaimer. 11 | 12 | 2. Redistributions in binary form must reproduce the above copyright notice, 13 | this list of conditions and the following disclaimer in the documentation 14 | and/or other materials provided with the distribution. 15 | 16 | 3. Neither the name of the copyright holder nor the names of its 17 | contributors may be used to endorse or promote products derived from 18 | this software without specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Grafana Dashboards for JupyterHub 2 | 3 | [![Documentation build status](https://img.shields.io/readthedocs/jupyterhub-grafana?logo=read-the-docs)](https://jupyterhub-grafana.readthedocs.org/en/latest/) 4 | 5 | Grafana Dashboards for use with [Zero to JupyterHub on Kubernetes](http://z2jh.jupyter.org/) 6 | 7 | ![Grafana Dasboard Screencast](demo.gif) 8 | 9 | ## What? 10 | 11 | Grafana dashboards displaying prometheus metrics are *extremely* useful in diagnosing 12 | issues on Kubernetes clusters running JupyterHub. However, everyone has to build their 13 | own dashboards - there isn't an easy way to standardize them across many clusters run 14 | by many entities. 15 | 16 | This project provides some standard [Grafana Dashboards as Code](https://grafana.com/blog/2020/02/26/how-to-configure-grafana-as-code/) 17 | to help with this. It uses [jsonnet](https://jsonnet.org/) and 18 | [grafonnet](https://github.com/grafana/grafonnet-lib) to generate dashboards completely 19 | via code. This can then be deployed on any Grafana instance! 20 | 21 | ## Deployment 22 | 23 | Deployment instructions are available in [the documentation site](https://jupyterhub-grafana.readthedocs.io/en/latest/tutorials/deploy.html). 24 | -------------------------------------------------------------------------------- /demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jupyterhub/grafana-dashboards/18ba92d98cd297951673850a4c92507479ec4ca2/demo.gif -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | project = 'JupyterHub Grafana Dashboards' 2 | copyright = '2023, Project Jupyter Contributors' 3 | author = 'Project Jupyter Contributors' 4 | 5 | 6 | extensions = [ 7 | "myst_parser", 8 | ] 9 | 10 | myst_enable_extensions = [ 11 | "deflist", 12 | "colon_fence", 13 | ] 14 | 15 | source_suffix = [".rst", ".md"] 16 | 17 | templates_path = ['_templates'] 18 | 19 | # List of patterns, relative to source directory, that match files and 20 | # directories to ignore when looking for source files. 21 | # This pattern also affects html_static_path and html_extra_path. 22 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 23 | 24 | 25 | # -- Options for HTML output ------------------------------------------------- 26 | 27 | # The theme to use for HTML and HTML Help pages. See the documentation for 28 | # a list of builtin themes. 29 | # 30 | html_theme = 'sphinx_book_theme' 31 | 32 | # Add any paths that contain custom static files (such as style sheets) here, 33 | # relative to this directory. They are copied after the builtin static files, 34 | # so a file named "default.css" will overwrite the builtin "default.css". 35 | html_static_path = ['_static'] 36 | -------------------------------------------------------------------------------- /docs/explanation/index.md: -------------------------------------------------------------------------------- 1 | (explanation)= 2 | # Explanation 3 | 4 | The documentation in this sections aims to _explain_ and _clarify_ a particular 5 | topic within the project in order to broaden the reader's understanding. 6 | 7 | ```{note} 8 | [Read more about the Explanation quadrant of the diataxis framework.](https://diataxis.fr/explanation/) 9 | ``` 10 | 11 | ```{attention} 12 | This documentation is a Work in Progress! 13 | Please see our [contributing guide](contributing) if you'd like to add to it. 14 | ``` 15 | 16 | % As files are added into this folder, you can add them to the below section so 17 | % that they appear in the table of contents 18 | ```{toctree} 19 | :maxdepth: 2 20 | ``` 21 | -------------------------------------------------------------------------------- /docs/howto/images.md: -------------------------------------------------------------------------------- 1 | # Find what images users are using 2 | 3 | With kubespawner's `profileList` feature, end users may choose different 4 | images to launch. It is useful to measure what images are being used so we 5 | can serve our users better over time. 6 | 7 | The "Images used by user pods" graph in the JupyterHub dashboard helps with this. 8 | It shows the popularity of various images used over time. Note that if an image 9 | is no used at all, it will not be shown. 10 | -------------------------------------------------------------------------------- /docs/howto/index.md: -------------------------------------------------------------------------------- 1 | (howto)= 2 | # How-To Guides 3 | 4 | The documentation in this section is _goal-oriented_ and designed to guide the 5 | reader through specific steps to reach that goal. 6 | 7 | ```{note} 8 | [Read more about the How-To quadrant of the diataxis framework.](https://diataxis.fr/how-to-guides/) 9 | ``` 10 | 11 | ```{attention} 12 | This documentation is a Work in Progress! 13 | Please see our [contributing guide](contributing) if you'd like to add to it. 14 | ``` 15 | 16 | ```{toctree} 17 | images.md 18 | user-diagnostics.md 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/howto/user-diagnostics.md: -------------------------------------------------------------------------------- 1 | # Look at individual user metrics 2 | 3 | A common support request for JupyterHub admins pertains to specific issues 4 | faced by a particular user. The "User Diagnostics" dashboard helps with this. 5 | It also helps look for *outliers* in a hub - people using too much of a particular 6 | resource, or not enough of a particular resource. 7 | 8 | ## Home directory size (with shared volumes) 9 | 10 | If you use a shared volume (such as NFS) for home directory storage, you can 11 | use the [prometheus-dirsize-exporter](https://github.com/yuvipanda/prometheus-dirsize-exporter) 12 | to efficiently collect information about the *size* of each user's home directory. 13 | Once [deployed](howto:deploy:per-user-home-dir), the exporter will collect slowly 14 | collect informatiohn about the size of each user's home directory and make that 15 | available to prometheus. The "Home directory usage (on shared home directories)" 16 | graph will display this over time. 17 | 18 | ```{note} 19 | The exporter is optimized to use as few IOPS as possible, to make sure we do 20 | not reduce performance for end users actually using the home directories to store 21 | stuff. As a result, the sizes will probably be out of date and take a while to 22 | update, depending on how big the home directories are. Use these for general 23 | monitoring, nothing realtime. 24 | ``` 25 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to JupyterHub Grafana Dashboards's documentation! 2 | 3 | Grafana Dashboards for use with [Zero to JupyterHub on Kubernetes](http://z2jh.jupyter.org/) 4 | 5 | ![Grafana Dasboard Screencast](../demo.gif) 6 | 7 | ## What? 8 | 9 | Grafana dashboards displaying prometheus metrics are *extremely* useful in diagnosing 10 | issues on Kubernetes clusters running JupyterHub. However, everyone has to build their 11 | own dashboards - there isn't an easy way to standardize them across many clusters run 12 | by many entities. 13 | 14 | This project provides some standard [Grafana Dashboards as Code](https://grafana.com/blog/2020/02/26/how-to-configure-grafana-as-code/) 15 | to help with this. It uses [jsonnet](https://jsonnet.org/) and 16 | [grafonnet](https://github.com/grafana/grafonnet-lib) to generate dashboards completely 17 | via code. This can then be deployed on any Grafana instance! 18 | 19 | ## How the documentation is organised 20 | 21 | We are currently using the [diátaxis framework](https://diataxis.fr/) to organise 22 | our docs into four main categories: 23 | 24 | - [**Tutorials**](tutorials): Step-by-step guides to complete a specific task 25 | - [**How-To guides**](howto): Directions to solve scenarios faced while using the project. Their titles often complete the sentence "How do I...?" 26 | - [**Explanation**](explanation): More in-depth discussion of topics within the project to broaden understanding. 27 | - [**Reference**](ref): Technical descriptions of the components within the project, and how to use them 28 | 29 | ### Tutorials 30 | 31 | ```{toctree} 32 | :maxdepth: 2 33 | tutorials/index.md 34 | ``` 35 | 36 | ### How-to Guides 37 | 38 | ```{toctree} 39 | :maxdepth: 2 40 | howto/index.md 41 | ``` 42 | 43 | ### Explanation 44 | 45 | ```{toctree} 46 | :maxdepth: 2 47 | explanation/index.md 48 | ``` 49 | 50 | ### Reference 51 | 52 | ```{toctree} 53 | reference/index.md 54 | ``` 55 | 56 | ## Contributing 57 | 58 | Thank you for considering contributing! You can find some details to help you 59 | get started in the sections below. 60 | 61 | ```{toctree} 62 | :maxdepth: 2 63 | contributing.md 64 | ``` 65 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | %SPHINXBUILD% >NUL 2>NUL 14 | if errorlevel 9009 ( 15 | echo. 16 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 17 | echo.installed, then set the SPHINXBUILD environment variable to point 18 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 19 | echo.may add the Sphinx directory to PATH. 20 | echo. 21 | echo.If you don't have Sphinx installed, grab it from 22 | echo.https://www.sphinx-doc.org/ 23 | exit /b 1 24 | ) 25 | 26 | if "%1" == "" goto help 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /docs/reference/index.md: -------------------------------------------------------------------------------- 1 | (ref)= 2 | # Reference 3 | 4 | The documentation in this section provides technical descriptions of the 5 | components used throughout the project, and how to use them. 6 | 7 | ```{note} 8 | [Read more about the Reference quadrant of the diataxis framework.](https://diataxis.fr/reference/) 9 | ``` 10 | 11 | ```{attention} 12 | This documentation is a Work in Progress! 13 | Please see our [contributing guide](contributing) if you'd like to add to it. 14 | ``` 15 | 16 | % As files are added into this folder, you can add them to the below section so 17 | % that they appear in the table of contents 18 | ```{toctree} 19 | :maxdepth: 2 20 | ``` 21 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | myst-parser[linkify] 2 | sphinx-autobuild 3 | sphinx-book-theme 4 | -------------------------------------------------------------------------------- /docs/tutorials/index.md: -------------------------------------------------------------------------------- 1 | (tutorials)= 2 | # Tutorials 3 | 4 | The documentation in this section are step-by-step guides that lead the reader 5 | through completing a specific task. 6 | 7 | ```{note} 8 | [Read more about the Tutorials quadrant of the diataxis framework.](https://diataxis.fr/tutorials/) 9 | ``` 10 | 11 | ```{attention} 12 | This documentation is a Work in Progress! 13 | Please see our [contributing guide](contributing) if you'd like to add to it. 14 | ``` 15 | 16 | ```{toctree} 17 | :maxdepth: 2 18 | deploy.md 19 | ``` 20 | -------------------------------------------------------------------------------- /jsonnetfile.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 1, 3 | "dependencies": [ 4 | { 5 | "name": "grafonnet", 6 | "source": { 7 | "git": { 8 | "remote": "https://github.com/grafana/grafonnet.git", 9 | "subdir": "gen/grafonnet-v11.1.0" 10 | } 11 | }, 12 | "version": "main" 13 | } 14 | ], 15 | "legacyImports": true 16 | } 17 | -------------------------------------------------------------------------------- /jsonnetfile.lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 1, 3 | "dependencies": [ 4 | { 5 | "source": { 6 | "git": { 7 | "remote": "https://github.com/grafana/grafonnet.git", 8 | "subdir": "gen/grafonnet-v11.1.0" 9 | } 10 | }, 11 | "version": "1ce5aec95ce32336fe47c8881361847c475b5254", 12 | "sum": "41w7p/rwrNsITqNHMXtGSJAfAyKmnflg6rFhKBduUxM=", 13 | "name": "grafonnet" 14 | }, 15 | { 16 | "source": { 17 | "git": { 18 | "remote": "https://github.com/jsonnet-libs/docsonnet.git", 19 | "subdir": "doc-util" 20 | } 21 | }, 22 | "version": "6ac6c69685b8c29c54515448eaca583da2d88150", 23 | "sum": "BrAL/k23jq+xy9oA7TWIhUx07dsA/QLm3g7ktCwe//U=" 24 | }, 25 | { 26 | "source": { 27 | "git": { 28 | "remote": "https://github.com/jsonnet-libs/xtd.git", 29 | "subdir": "" 30 | } 31 | }, 32 | "version": "63d430b69a95741061c2f7fc9d84b1a778511d9c", 33 | "sum": "qiZi3axUSXCVzKUF83zSAxklwrnitMmrDK4XAfjPMdE=" 34 | } 35 | ], 36 | "legacyImports": false 37 | } 38 | -------------------------------------------------------------------------------- /noxfile.py: -------------------------------------------------------------------------------- 1 | """ 2 | noxfile.py is a configuration file for the command-line tool nox that automates 3 | tasks in multiple Python environments. We use it to setup an environment to 4 | build our documentation. 5 | 6 | Config reference: https://nox.thea.codes/en/stable/config.html#noxfile 7 | 8 | Common tasks: 9 | - Install nox: pip install nox 10 | - Start a live reloading docs server: nox -s docs -- live 11 | """ 12 | 13 | import nox 14 | 15 | nox.options.reuse_existing_virtualenvs = True 16 | 17 | BUILD_COMMAND = ["-b", "html", "docs", "docs/_build/html"] 18 | 19 | 20 | @nox.session(venv_backend="conda") 21 | def docs(session): 22 | """Build the documentation. Use `-- live` for a live server to preview changes.""" 23 | session.install("-r", "docs/requirements.txt") 24 | 25 | if "live" in session.posargs: 26 | session.posargs.pop(session.posargs.index("live")) 27 | 28 | # Add folders to ignore 29 | AUTOBUILD_IGNORE = [ 30 | "_build", 31 | "tmp", 32 | ] 33 | 34 | cmd = ["sphinx-autobuild"] 35 | for folder in AUTOBUILD_IGNORE: 36 | cmd.extend(["--ignore", f"*/{folder}/*"]) 37 | 38 | # Find an open port to serve on 39 | cmd.extend(["--port", "0"]) 40 | 41 | else: 42 | cmd = ["sphinx-build"] 43 | 44 | cmd.extend(BUILD_COMMAND + session.posargs) 45 | session.run(*cmd) 46 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | # autoflake is used for autoformatting Python code 2 | # 3 | # ref: https://github.com/PyCQA/autoflake#readme 4 | # 5 | [tool.autoflake] 6 | ignore-init-module-imports = true 7 | remove-all-unused-imports = true 8 | remove-duplicate-keys = true 9 | remove-unused-variables = true 10 | 11 | 12 | # black is used for autoformatting Python code 13 | # 14 | # ref: https://black.readthedocs.io/en/stable/ 15 | # 16 | [tool.black] 17 | skip-string-normalization = true 18 | # target-version should be all supported versions, see 19 | # https://github.com/psf/black/issues/751#issuecomment-473066811 20 | target_version = [ 21 | "py38", 22 | "py39", 23 | "py310", 24 | "py311", 25 | ] 26 | 27 | 28 | # isort is used for autoformatting Python code 29 | # 30 | # ref: https://pycqa.github.io/isort/ 31 | # 32 | [tool.isort] 33 | profile = "black" 34 | -------------------------------------------------------------------------------- /vendor/doc-util: -------------------------------------------------------------------------------- 1 | github.com/jsonnet-libs/docsonnet/doc-util -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/alerting.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.alerting', name: 'alerting' }, 4 | contactPoint: import 'clean/alerting/contactPoint.libsonnet', 5 | notificationPolicy: import 'clean/alerting/notificationPolicy.libsonnet', 6 | muteTiming: import 'clean/alerting/muteTiming.libsonnet', 7 | ruleGroup: import 'clean/alerting/ruleGroup.libsonnet', 8 | notificationTemplate: import 'clean/alerting/notificationTemplate.libsonnet', 9 | } 10 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/clean/alerting/contactPoint.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, 4 | '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 5 | withDisableResolveMessage(value=true): { 6 | disableResolveMessage: value, 7 | }, 8 | '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 9 | withName(value): { 10 | name: value, 11 | }, 12 | '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 13 | withProvenance(value): { 14 | provenance: value, 15 | }, 16 | '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 17 | withSettings(value): { 18 | settings: value, 19 | }, 20 | '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 21 | withSettingsMixin(value): { 22 | settings+: value, 23 | }, 24 | '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 25 | withType(value): { 26 | type: value, 27 | }, 28 | '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, 29 | withUid(value): { 30 | uid: value, 31 | }, 32 | } 33 | + (import '../../custom/alerting/contactPoint.libsonnet') 34 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/clean/alerting/notificationTemplate.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.alerting.notificationTemplate', name: 'notificationTemplate' }, 4 | '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, 5 | withName(value): { 6 | name: value, 7 | }, 8 | '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, 9 | withProvenance(value): { 10 | provenance: value, 11 | }, 12 | '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, 13 | withTemplate(value): { 14 | template: value, 15 | }, 16 | } 17 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/alerting/contactPoint.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#'+:: { 5 | help+: 6 | ||| 7 | 8 | 9 | **NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. 10 | |||, 11 | }, 12 | } 13 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/alerting/muteTiming.libsonnet: -------------------------------------------------------------------------------- 1 | { 2 | '#withTimeIntervals': { ignore: true }, 3 | '#withIntervals': super['#withTimeIntervals'], 4 | withIntervals: super.withTimeIntervals, 5 | '#withTimeIntervalsMixin': { ignore: true }, 6 | '#withIntervalsMixin': super['#withTimeIntervalsMixin'], 7 | withIntervalsMixin: super.withTimeIntervalsMixin, 8 | } 9 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/alerting/notificationPolicy.libsonnet: -------------------------------------------------------------------------------- 1 | { 2 | '#withReceiver': { ignore: true }, 3 | '#withContactPoint': super['#withReceiver'], 4 | withContactPoint: super.withReceiver, 5 | 6 | '#withRoutes': { ignore: true }, 7 | '#withPolicy': super['#withRoutes'], 8 | withPolicy: super.withRoutes, 9 | '#withRoutesMixin': { ignore: true }, 10 | '#withPolicyMixin': super['#withRoutesMixin'], 11 | withPolicyMixin: super.withRoutesMixin, 12 | } 13 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/alerting/ruleGroup.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withTitle': { ignore: true }, 5 | '#withName': super['#withTitle'], 6 | withName: super.withTitle, 7 | rule+: { 8 | '#':: d.package.newSub('rule', ''), 9 | '#withTitle': { ignore: true }, 10 | '#withName': super['#withTitle'], 11 | withName: super.withTitle, 12 | }, 13 | } 14 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/dashboard.libsonnet: -------------------------------------------------------------------------------- 1 | local util = import './util/main.libsonnet'; 2 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 3 | 4 | { 5 | '#new':: d.func.new( 6 | 'Creates a new dashboard with a title.', 7 | args=[d.arg('title', d.T.string)] 8 | ), 9 | new(title): 10 | self.withTitle(title) 11 | + self.withSchemaVersion() 12 | + self.withTimezone('utc') 13 | + self.time.withFrom('now-6h') 14 | + self.time.withTo('now'), 15 | 16 | '#withSchemaVersion': { 'function'+: { args: [d.arg('value', d.T.integer, default=39)] } }, 17 | withSchemaVersion(value=39): { 18 | schemaVersion: value, 19 | }, 20 | 21 | '#withPanels':: d.func.new( 22 | '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', 23 | args=[ 24 | d.arg('panels', d.T.array), 25 | d.arg('setPanelIDs', d.T.bool, default=true), 26 | ] 27 | ), 28 | withPanels(panels, setPanelIDs=true): { 29 | _panels:: if std.isArray(panels) then panels else [panels], 30 | panels: 31 | if setPanelIDs 32 | then util.panel.setPanelIDs(self._panels) 33 | else self._panels, 34 | }, 35 | '#withPanelsMixin':: d.func.new( 36 | '`withPanelsMixin` adds more panels to a dashboard.', 37 | args=[ 38 | d.arg('panels', d.T.array), 39 | d.arg('setPanelIDs', d.T.bool, default=true), 40 | ] 41 | ), 42 | withPanelsMixin(panels, setPanelIDs=true): { 43 | _panels+:: if std.isArray(panels) then panels else [panels], 44 | panels: 45 | if setPanelIDs 46 | then util.panel.setPanelIDs(self._panels) 47 | else self._panels, 48 | }, 49 | 50 | graphTooltip+: { 51 | // 0 - Default 52 | // 1 - Shared crosshair 53 | // 2 - Shared tooltip 54 | '#withSharedCrosshair':: d.func.new( 55 | 'Share crosshair on all panels.', 56 | ), 57 | withSharedCrosshair(): 58 | { graphTooltip: 1 }, 59 | 60 | '#withSharedTooltip':: d.func.new( 61 | 'Share crosshair and tooltip on all panels.', 62 | ), 63 | withSharedTooltip(): 64 | { graphTooltip: 2 }, 65 | }, 66 | } 67 | + (import './dashboard/annotation.libsonnet') 68 | + (import './dashboard/link.libsonnet') 69 | + (import './dashboard/variable.libsonnet') 70 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/dashboard/annotation.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#annotation':: {}, 5 | 6 | '#withAnnotations': 7 | d.func.new( 8 | ||| 9 | `withAnnotations` adds an array of annotations to a dashboard. 10 | 11 | This function appends passed data to existing values 12 | |||, 13 | args=[d.arg('value', d.T.array)] 14 | ), 15 | withAnnotations(value): super.annotation.withList(value), 16 | 17 | '#withAnnotationsMixin': 18 | d.func.new( 19 | ||| 20 | `withAnnotationsMixin` adds an array of annotations to a dashboard. 21 | 22 | This function appends passed data to existing values 23 | |||, 24 | args=[d.arg('value', d.T.array)] 25 | ), 26 | withAnnotationsMixin(value): super.annotation.withListMixin(value), 27 | 28 | annotation: 29 | super.annotation.list 30 | + { 31 | '#':: d.package.newSub( 32 | 'annotation', 33 | '', 34 | ), 35 | }, 36 | } 37 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/dashboard/link.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withLinks':: d.func.new( 5 | ||| 6 | Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. 7 | 8 | `withLinks` takes an array of [link objects](./link.md). 9 | 10 | The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. 11 | 12 | Example: 13 | 14 | ```jsonnet 15 | local g = import 'g.libsonnet'; 16 | local link = g.dashboard.link; 17 | 18 | g.dashboard.new('Title dashboard') 19 | + g.dashboard.withLinks([ 20 | link.link.new('My title', 'https://wikipedia.org/'), 21 | ]) 22 | ``` 23 | |||, 24 | [d.arg('value', d.T.array)], 25 | ), 26 | '#withLinksMixin':: self['#withLinks'], 27 | 28 | link+: { 29 | '#':: d.package.newSub( 30 | 'link', 31 | ||| 32 | Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. 33 | 34 | The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. 35 | 36 | Example: 37 | 38 | ```jsonnet 39 | local g = import 'g.libsonnet'; 40 | local link = g.dashboard.link; 41 | 42 | g.dashboard.new('Title dashboard') 43 | + g.dashboard.withLinks([ 44 | link.link.new('My title', 'https://wikipedia.org/'), 45 | ]) 46 | ``` 47 | |||, 48 | ), 49 | 50 | dashboards+: { 51 | '#new':: d.func.new( 52 | ||| 53 | Create links to dashboards based on `tags`. 54 | |||, 55 | args=[ 56 | d.arg('title', d.T.string), 57 | d.arg('tags', d.T.array), 58 | ] 59 | ), 60 | new(title, tags): 61 | self.withTitle(title) 62 | + self.withType('dashboards') 63 | + self.withTags(tags), 64 | 65 | '#withTitle':: {}, 66 | '#withType':: {}, 67 | '#withTags':: {}, 68 | }, 69 | 70 | link+: { 71 | '#new':: d.func.new( 72 | ||| 73 | Create link to an arbitrary URL. 74 | |||, 75 | args=[ 76 | d.arg('title', d.T.string), 77 | d.arg('url', d.T.string), 78 | ] 79 | ), 80 | new(title, url): 81 | self.withTitle(title) 82 | + self.withType('link') 83 | + self.withUrl(url), 84 | 85 | '#withTitle':: {}, 86 | '#withType':: {}, 87 | '#withUrl':: {}, 88 | }, 89 | }, 90 | } 91 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/azureMonitor.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withDatasource':: d.func.new( 5 | 'Set the datasource for this query.', 6 | args=[ 7 | d.arg('value', d.T.string), 8 | ] 9 | ), 10 | withDatasource(value): { 11 | datasource+: { 12 | type: 'grafana-azure-monitor-datasource', 13 | uid: value, 14 | }, 15 | }, 16 | '#withDatasourceMixin':: { ignore: true }, 17 | } 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/cloudWatch.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | local withDatasourceStub = { 5 | '#withDatasource':: d.func.new( 6 | 'Set the datasource for this query.', 7 | args=[ 8 | d.arg('value', d.T.string), 9 | ] 10 | ), 11 | withDatasource(value): { 12 | datasource+: { 13 | type: 'cloudwatch', 14 | uid: value, 15 | }, 16 | }, 17 | '#withDatasourceMixin':: { ignore: true }, 18 | }, 19 | 20 | CloudWatchAnnotationQuery+: withDatasourceStub, 21 | CloudWatchLogsQuery+: withDatasourceStub, 22 | CloudWatchMetricsQuery+: withDatasourceStub, 23 | } 24 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/elasticsearch.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, 5 | metrics+: { '#': { help: '', name: 'metrics' } }, 6 | 7 | '#withDatasource':: d.func.new( 8 | 'Set the datasource for this query.', 9 | args=[ 10 | d.arg('value', d.T.string), 11 | ] 12 | ), 13 | withDatasource(value): { 14 | datasource+: { 15 | type: 'elasticsearch', 16 | uid: value, 17 | }, 18 | }, 19 | '#withDatasourceMixin':: { ignore: true }, 20 | } 21 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/expr.libsonnet: -------------------------------------------------------------------------------- 1 | { 2 | '#': { 3 | help: 'Server Side Expression operations for grafonnet.alerting.ruleGroup.rule', 4 | name: 'expr', 5 | }, 6 | TypeMath+: { '#': { help: 'grafonnet.query.expr.TypeMath', name: 'TypeMath' } }, 7 | TypeReduce+: { '#': { help: 'grafonnet.query.expr.TypeReduce', name: 'TypeReduce' } }, 8 | TypeResample+: { '#': { help: 'grafonnet.query.expr.TypeResample', name: 'TypeResample' } }, 9 | TypeClassicConditions+: { '#': { help: 'grafonnet.query.expr.TypeClassicConditions', name: 'TypeClassicConditions' } }, 10 | TypeThreshold+: { '#': { help: 'grafonnet.query.expr.TypeThreshold', name: 'TypeThreshold' } }, 11 | TypeSql+: { '#': { help: 'grafonnet.query.expr.TypeSql', name: 'TypeSql' } }, 12 | } 13 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/googleCloudMonitoring.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withDatasource':: d.func.new( 5 | 'Set the datasource for this query.', 6 | args=[ 7 | d.arg('value', d.T.string), 8 | ] 9 | ), 10 | withDatasource(value): { 11 | datasource+: { 12 | type: 'cloud-monitoring', 13 | uid: value, 14 | }, 15 | }, 16 | '#withDatasourceMixin':: { ignore: true }, 17 | } 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/grafanaPyroscope.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withDatasource':: d.func.new( 5 | 'Set the datasource for this query.', 6 | args=[ 7 | d.arg('value', d.T.string), 8 | ] 9 | ), 10 | withDatasource(value): { 11 | datasource+: { 12 | type: 'grafanapyroscope', 13 | uid: value, 14 | }, 15 | }, 16 | '#withDatasourceMixin':: { ignore: true }, 17 | } 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/loki.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#new':: d.func.new( 5 | 'Creates a new loki query target for panels.', 6 | args=[ 7 | d.arg('datasource', d.T.string), 8 | d.arg('expr', d.T.string), 9 | ] 10 | ), 11 | new(datasource, expr): 12 | self.withDatasource(datasource) 13 | + self.withExpr(expr), 14 | 15 | '#withDatasource':: d.func.new( 16 | 'Set the datasource for this query.', 17 | args=[ 18 | d.arg('value', d.T.string), 19 | ] 20 | ), 21 | withDatasource(value): { 22 | datasource+: { 23 | type: 'loki', 24 | uid: value, 25 | }, 26 | }, 27 | '#withDatasourceMixin':: { ignore: true }, 28 | } 29 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/parca.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withDatasource':: d.func.new( 5 | 'Set the datasource for this query.', 6 | args=[ 7 | d.arg('value', d.T.string), 8 | ] 9 | ), 10 | withDatasource(value): { 11 | datasource+: { 12 | type: 'parca', 13 | uid: value, 14 | }, 15 | }, 16 | '#withDatasourceMixin':: { ignore: true }, 17 | } 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/prometheus.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#new':: d.func.new( 5 | 'Creates a new prometheus query target for panels.', 6 | args=[ 7 | d.arg('datasource', d.T.string), 8 | d.arg('expr', d.T.string), 9 | ] 10 | ), 11 | new(datasource, expr): 12 | self.withDatasource(datasource) 13 | + self.withExpr(expr), 14 | 15 | '#withIntervalFactor':: d.func.new( 16 | 'Set the interval factor for this query.', 17 | args=[ 18 | d.arg('value', d.T.string), 19 | ] 20 | ), 21 | withIntervalFactor(value): { 22 | intervalFactor: value, 23 | }, 24 | 25 | '#withLegendFormat':: d.func.new( 26 | 'Set the legend format for this query.', 27 | args=[ 28 | d.arg('value', d.T.string), 29 | ] 30 | ), 31 | withLegendFormat(value): { 32 | legendFormat: value, 33 | }, 34 | 35 | '#withDatasource':: d.func.new( 36 | 'Set the datasource for this query.', 37 | args=[ 38 | d.arg('value', d.T.string), 39 | ] 40 | ), 41 | withDatasource(value): { 42 | datasource+: { 43 | type: 'prometheus', 44 | uid: value, 45 | }, 46 | }, 47 | '#withDatasourceMixin':: { ignore: true }, 48 | } 49 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/tempo.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#new':: d.func.new( 5 | 'Creates a new tempo query target for panels.', 6 | args=[ 7 | d.arg('datasource', d.T.string), 8 | d.arg('query', d.T.string), 9 | d.arg('filters', d.T.array), 10 | ] 11 | ), 12 | new(datasource, query, filters): 13 | self.withDatasource(datasource) 14 | + self.withQuery(query) 15 | + self.withFilters(filters), 16 | 17 | '#withDatasource':: d.func.new( 18 | 'Set the datasource for this query.', 19 | args=[ 20 | d.arg('value', d.T.string), 21 | ] 22 | ), 23 | withDatasource(value): { 24 | datasource+: { 25 | type: 'tempo', 26 | uid: value, 27 | }, 28 | }, 29 | '#withDatasourceMixin':: { ignore: true }, 30 | } 31 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/query/testData.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#withDatasource':: d.func.new( 5 | 'Set the datasource for this query.', 6 | args=[ 7 | d.arg('value', d.T.string), 8 | ] 9 | ), 10 | withDatasource(): { 11 | datasource+: { 12 | type: 'datasource', 13 | uid: 'grafana', 14 | }, 15 | }, 16 | '#withDatasourceMixin':: { ignore: true }, 17 | } 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/row.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#new':: d.func.new( 5 | 'Creates a new row panel with a title.', 6 | args=[d.arg('title', d.T.string)] 7 | ), 8 | new(title): 9 | self.withTitle(title) 10 | + self.withType() 11 | + self.withCollapsed(false) 12 | + self.gridPos.withX(0) 13 | + self.gridPos.withH(1) 14 | + self.gridPos.withW(24), 15 | 16 | '#gridPos':: {}, // use withGridPos instead 17 | '#withGridPos':: d.func.new( 18 | '`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values.', 19 | args=[d.arg('y', d.T.number)] 20 | ), 21 | withGridPos(y): 22 | self.gridPos.withX(0) 23 | + self.gridPos.withY(y) 24 | + self.gridPos.withH(1) 25 | + self.gridPos.withW(24), 26 | } 27 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/util/dashboard.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; 3 | 4 | { 5 | local root = self, 6 | 7 | '#getOptionsForCustomQuery':: d.func.new( 8 | ||| 9 | `getOptionsForCustomQuery` provides values for the `options` and `current` fields. 10 | These are required for template variables of type 'custom'but do not automatically 11 | get populated by Grafana when importing a dashboard from JSON. 12 | 13 | This is a bit of a hack and should always be called on functions that set `type` on 14 | a template variable. Ideally Grafana populates these fields from the `query` value 15 | but this provides a backwards compatible solution. 16 | |||, 17 | args=[d.arg('query', d.T.string)], 18 | ), 19 | getOptionsForCustomQuery(query, multi): { 20 | local values = root.parseCustomQuery(query), 21 | current: root.getCurrentFromValues(values, multi), 22 | options: root.getOptionsFromValues(values), 23 | }, 24 | 25 | getCurrentFromValues(values, multi): { 26 | selected: false, 27 | text: if multi then [values[0].key] else values[0].key, 28 | value: if multi then [values[0].value] else values[0].value, 29 | }, 30 | 31 | getOptionsFromValues(values): 32 | std.mapWithIndex( 33 | function(i, item) { 34 | selected: i == 0, 35 | text: item.key, 36 | value: item.value, 37 | }, 38 | values 39 | ), 40 | 41 | parseCustomQuery(query): 42 | std.map( 43 | function(v) 44 | // Split items into key:value pairs 45 | local split = std.splitLimit(v, ' : ', 1); 46 | { 47 | key: std.stripChars(split[0], ' '), 48 | value: 49 | if std.length(split) == 2 50 | then std.stripChars(split[1], ' ') 51 | else self.key, 52 | }, 53 | xtd.string.splitEscape(query, ',') // Split query by comma, unless the comma is escaped 54 | ), 55 | } 56 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/util/main.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#': d.package.newSub('util', 'Helper functions that work well with Grafonnet.'), 5 | dashboard: (import './dashboard.libsonnet'), 6 | grid: (import './grid.libsonnet'), 7 | panel: (import './panel.libsonnet'), 8 | string: (import './string.libsonnet'), 9 | } 10 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/custom/util/string.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; 3 | 4 | { 5 | '#slugify':: d.func.new( 6 | ||| 7 | `slugify` will create a simple slug from `string`, keeping only alphanumeric 8 | characters and replacing spaces with dashes. 9 | |||, 10 | args=[d.arg('string', d.T.string)] 11 | ), 12 | slugify(string): 13 | std.strReplace( 14 | std.asciiLower( 15 | std.join('', [ 16 | string[i] 17 | for i in std.range(0, std.length(string) - 1) 18 | if xtd.ascii.isUpper(string[i]) 19 | || xtd.ascii.isLower(string[i]) 20 | || xtd.ascii.isNumber(string[i]) 21 | || string[i] == ' ' 22 | ]) 23 | ), 24 | ' ', 25 | '-', 26 | ), 27 | } 28 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/README.md: -------------------------------------------------------------------------------- 1 | # grafonnet 2 | 3 | Jsonnet library for rendering Grafana resources 4 | ## Install 5 | 6 | ``` 7 | jb install github.com/grafana/grafonnet/gen/grafonnet-v11.1.0@main 8 | ``` 9 | 10 | ## Usage 11 | 12 | ```jsonnet 13 | local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet" 14 | ``` 15 | 16 | 17 | ## Subpackages 18 | 19 | * [accesspolicy](accesspolicy/index.md) 20 | * [alerting](alerting/index.md) 21 | * [dashboard](dashboard/index.md) 22 | * [folder](folder.md) 23 | * [librarypanel](librarypanel/index.md) 24 | * [panel](panel/index.md) 25 | * [preferences](preferences.md) 26 | * [publicdashboard](publicdashboard.md) 27 | * [query](query/index.md) 28 | * [role](role.md) 29 | * [rolebinding](rolebinding.md) 30 | * [team](team.md) 31 | * [util](util.md) 32 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/accesspolicy/index.md: -------------------------------------------------------------------------------- 1 | # accesspolicy 2 | 3 | grafonnet.accesspolicy 4 | 5 | ## Subpackages 6 | 7 | * [rules](rules.md) 8 | 9 | ## Index 10 | 11 | * [`fn withRole(value)`](#fn-withrole) 12 | * [`fn withRoleMixin(value)`](#fn-withrolemixin) 13 | * [`fn withRules(value)`](#fn-withrules) 14 | * [`fn withRulesMixin(value)`](#fn-withrulesmixin) 15 | * [`fn withScope(value)`](#fn-withscope) 16 | * [`fn withScopeMixin(value)`](#fn-withscopemixin) 17 | * [`obj role`](#obj-role) 18 | * [`fn withKind(value)`](#fn-rolewithkind) 19 | * [`fn withName(value)`](#fn-rolewithname) 20 | * [`fn withXname(value)`](#fn-rolewithxname) 21 | * [`obj scope`](#obj-scope) 22 | * [`fn withKind(value)`](#fn-scopewithkind) 23 | * [`fn withName(value)`](#fn-scopewithname) 24 | 25 | ## Fields 26 | 27 | ### fn withRole 28 | 29 | ```jsonnet 30 | withRole(value) 31 | ``` 32 | 33 | PARAMETERS: 34 | 35 | * **value** (`object`) 36 | 37 | The role that must apply this policy 38 | ### fn withRoleMixin 39 | 40 | ```jsonnet 41 | withRoleMixin(value) 42 | ``` 43 | 44 | PARAMETERS: 45 | 46 | * **value** (`object`) 47 | 48 | The role that must apply this policy 49 | ### fn withRules 50 | 51 | ```jsonnet 52 | withRules(value) 53 | ``` 54 | 55 | PARAMETERS: 56 | 57 | * **value** (`array`) 58 | 59 | The set of rules to apply. Note that * is required to modify 60 | access policy rules, and that "none" will reject all actions 61 | ### fn withRulesMixin 62 | 63 | ```jsonnet 64 | withRulesMixin(value) 65 | ``` 66 | 67 | PARAMETERS: 68 | 69 | * **value** (`array`) 70 | 71 | The set of rules to apply. Note that * is required to modify 72 | access policy rules, and that "none" will reject all actions 73 | ### fn withScope 74 | 75 | ```jsonnet 76 | withScope(value) 77 | ``` 78 | 79 | PARAMETERS: 80 | 81 | * **value** (`object`) 82 | 83 | The scope where these policies should apply 84 | ### fn withScopeMixin 85 | 86 | ```jsonnet 87 | withScopeMixin(value) 88 | ``` 89 | 90 | PARAMETERS: 91 | 92 | * **value** (`object`) 93 | 94 | The scope where these policies should apply 95 | ### obj role 96 | 97 | 98 | #### fn role.withKind 99 | 100 | ```jsonnet 101 | role.withKind(value) 102 | ``` 103 | 104 | PARAMETERS: 105 | 106 | * **value** (`string`) 107 | - valid values: `"Role"`, `"BuiltinRole"`, `"Team"`, `"User"` 108 | 109 | Policies can apply to roles, teams, or users 110 | Applying policies to individual users is supported, but discouraged 111 | #### fn role.withName 112 | 113 | ```jsonnet 114 | role.withName(value) 115 | ``` 116 | 117 | PARAMETERS: 118 | 119 | * **value** (`string`) 120 | 121 | 122 | #### fn role.withXname 123 | 124 | ```jsonnet 125 | role.withXname(value) 126 | ``` 127 | 128 | PARAMETERS: 129 | 130 | * **value** (`string`) 131 | 132 | 133 | ### obj scope 134 | 135 | 136 | #### fn scope.withKind 137 | 138 | ```jsonnet 139 | scope.withKind(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | 147 | #### fn scope.withName 148 | 149 | ```jsonnet 150 | scope.withName(value) 151 | ``` 152 | 153 | PARAMETERS: 154 | 155 | * **value** (`string`) 156 | 157 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/accesspolicy/rules.md: -------------------------------------------------------------------------------- 1 | # rules 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withKind(value="*")`](#fn-withkind) 8 | * [`fn withTarget(value)`](#fn-withtarget) 9 | * [`fn withVerb(value)`](#fn-withverb) 10 | * [`fn withVerbMixin(value)`](#fn-withverbmixin) 11 | 12 | ## Fields 13 | 14 | ### fn withKind 15 | 16 | ```jsonnet 17 | withKind(value="*") 18 | ``` 19 | 20 | PARAMETERS: 21 | 22 | * **value** (`string`) 23 | - default value: `"*"` 24 | 25 | The kind this rule applies to (dashboards, alert, etc) 26 | ### fn withTarget 27 | 28 | ```jsonnet 29 | withTarget(value) 30 | ``` 31 | 32 | PARAMETERS: 33 | 34 | * **value** (`string`) 35 | 36 | Specific sub-elements like "alert.rules" or "dashboard.permissions"???? 37 | ### fn withVerb 38 | 39 | ```jsonnet 40 | withVerb(value) 41 | ``` 42 | 43 | PARAMETERS: 44 | 45 | * **value** (`string`) 46 | 47 | READ, WRITE, CREATE, DELETE, ... 48 | should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" 49 | ### fn withVerbMixin 50 | 51 | ```jsonnet 52 | withVerbMixin(value) 53 | ``` 54 | 55 | PARAMETERS: 56 | 57 | * **value** (`string`) 58 | 59 | READ, WRITE, CREATE, DELETE, ... 60 | should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/contactPoint.md: -------------------------------------------------------------------------------- 1 | # contactPoint 2 | 3 | grafonnet.alerting.contactPoint 4 | 5 | **NOTE**: The schemas for all different contact points is under development, this means we can't properly express them in Grafonnet yet. The way this works now may change heavily. 6 | 7 | 8 | ## Index 9 | 10 | * [`fn withDisableResolveMessage(value=true)`](#fn-withdisableresolvemessage) 11 | * [`fn withName(value)`](#fn-withname) 12 | * [`fn withProvenance(value)`](#fn-withprovenance) 13 | * [`fn withSettings(value)`](#fn-withsettings) 14 | * [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) 15 | * [`fn withType(value)`](#fn-withtype) 16 | * [`fn withUid(value)`](#fn-withuid) 17 | 18 | ## Fields 19 | 20 | ### fn withDisableResolveMessage 21 | 22 | ```jsonnet 23 | withDisableResolveMessage(value=true) 24 | ``` 25 | 26 | PARAMETERS: 27 | 28 | * **value** (`boolean`) 29 | - default value: `true` 30 | 31 | EmbeddedContactPoint is the contact point type that is used 32 | by grafanas embedded alertmanager implementation. 33 | ### fn withName 34 | 35 | ```jsonnet 36 | withName(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | EmbeddedContactPoint is the contact point type that is used 44 | by grafanas embedded alertmanager implementation. 45 | ### fn withProvenance 46 | 47 | ```jsonnet 48 | withProvenance(value) 49 | ``` 50 | 51 | PARAMETERS: 52 | 53 | * **value** (`string`) 54 | 55 | EmbeddedContactPoint is the contact point type that is used 56 | by grafanas embedded alertmanager implementation. 57 | ### fn withSettings 58 | 59 | ```jsonnet 60 | withSettings(value) 61 | ``` 62 | 63 | PARAMETERS: 64 | 65 | * **value** (`object`) 66 | 67 | EmbeddedContactPoint is the contact point type that is used 68 | by grafanas embedded alertmanager implementation. 69 | ### fn withSettingsMixin 70 | 71 | ```jsonnet 72 | withSettingsMixin(value) 73 | ``` 74 | 75 | PARAMETERS: 76 | 77 | * **value** (`object`) 78 | 79 | EmbeddedContactPoint is the contact point type that is used 80 | by grafanas embedded alertmanager implementation. 81 | ### fn withType 82 | 83 | ```jsonnet 84 | withType(value) 85 | ``` 86 | 87 | PARAMETERS: 88 | 89 | * **value** (`string`) 90 | - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` 91 | 92 | EmbeddedContactPoint is the contact point type that is used 93 | by grafanas embedded alertmanager implementation. 94 | ### fn withUid 95 | 96 | ```jsonnet 97 | withUid(value) 98 | ``` 99 | 100 | PARAMETERS: 101 | 102 | * **value** (`string`) 103 | 104 | EmbeddedContactPoint is the contact point type that is used 105 | by grafanas embedded alertmanager implementation. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/index.md: -------------------------------------------------------------------------------- 1 | # alerting 2 | 3 | grafonnet.alerting 4 | 5 | ## Subpackages 6 | 7 | * [contactPoint](contactPoint.md) 8 | * [muteTiming](muteTiming/index.md) 9 | * [notificationPolicy](notificationPolicy/index.md) 10 | * [notificationTemplate](notificationTemplate.md) 11 | * [ruleGroup](ruleGroup/index.md) 12 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/muteTiming/index.md: -------------------------------------------------------------------------------- 1 | # muteTiming 2 | 3 | grafonnet.alerting.muteTiming 4 | 5 | ## Subpackages 6 | 7 | * [interval](interval/index.md) 8 | 9 | ## Index 10 | 11 | * [`fn withIntervals(value)`](#fn-withintervals) 12 | * [`fn withIntervalsMixin(value)`](#fn-withintervalsmixin) 13 | * [`fn withName(value)`](#fn-withname) 14 | 15 | ## Fields 16 | 17 | ### fn withIntervals 18 | 19 | ```jsonnet 20 | withIntervals(value) 21 | ``` 22 | 23 | PARAMETERS: 24 | 25 | * **value** (`array`) 26 | 27 | 28 | ### fn withIntervalsMixin 29 | 30 | ```jsonnet 31 | withIntervalsMixin(value) 32 | ``` 33 | 34 | PARAMETERS: 35 | 36 | * **value** (`array`) 37 | 38 | 39 | ### fn withName 40 | 41 | ```jsonnet 42 | withName(value) 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`string`) 48 | 49 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/muteTiming/interval/index.md: -------------------------------------------------------------------------------- 1 | # interval 2 | 3 | 4 | 5 | ## Subpackages 6 | 7 | * [time_intervals](time_intervals/index.md) 8 | 9 | ## Index 10 | 11 | * [`fn withName(value)`](#fn-withname) 12 | * [`fn withTimeIntervals(value)`](#fn-withtimeintervals) 13 | * [`fn withTimeIntervalsMixin(value)`](#fn-withtimeintervalsmixin) 14 | 15 | ## Fields 16 | 17 | ### fn withName 18 | 19 | ```jsonnet 20 | withName(value) 21 | ``` 22 | 23 | PARAMETERS: 24 | 25 | * **value** (`string`) 26 | 27 | 28 | ### fn withTimeIntervals 29 | 30 | ```jsonnet 31 | withTimeIntervals(value) 32 | ``` 33 | 34 | PARAMETERS: 35 | 36 | * **value** (`array`) 37 | 38 | 39 | ### fn withTimeIntervalsMixin 40 | 41 | ```jsonnet 42 | withTimeIntervalsMixin(value) 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`array`) 48 | 49 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/muteTiming/interval/time_intervals/index.md: -------------------------------------------------------------------------------- 1 | # time_intervals 2 | 3 | 4 | 5 | ## Subpackages 6 | 7 | * [times](times.md) 8 | 9 | ## Index 10 | 11 | * [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) 12 | * [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) 13 | * [`fn withLocation(value)`](#fn-withlocation) 14 | * [`fn withMonths(value)`](#fn-withmonths) 15 | * [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) 16 | * [`fn withTimes(value)`](#fn-withtimes) 17 | * [`fn withTimesMixin(value)`](#fn-withtimesmixin) 18 | * [`fn withWeekdays(value)`](#fn-withweekdays) 19 | * [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) 20 | * [`fn withYears(value)`](#fn-withyears) 21 | * [`fn withYearsMixin(value)`](#fn-withyearsmixin) 22 | 23 | ## Fields 24 | 25 | ### fn withDaysOfMonth 26 | 27 | ```jsonnet 28 | withDaysOfMonth(value) 29 | ``` 30 | 31 | PARAMETERS: 32 | 33 | * **value** (`array`) 34 | 35 | 36 | ### fn withDaysOfMonthMixin 37 | 38 | ```jsonnet 39 | withDaysOfMonthMixin(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`array`) 45 | 46 | 47 | ### fn withLocation 48 | 49 | ```jsonnet 50 | withLocation(value) 51 | ``` 52 | 53 | PARAMETERS: 54 | 55 | * **value** (`string`) 56 | 57 | 58 | ### fn withMonths 59 | 60 | ```jsonnet 61 | withMonths(value) 62 | ``` 63 | 64 | PARAMETERS: 65 | 66 | * **value** (`array`) 67 | 68 | 69 | ### fn withMonthsMixin 70 | 71 | ```jsonnet 72 | withMonthsMixin(value) 73 | ``` 74 | 75 | PARAMETERS: 76 | 77 | * **value** (`array`) 78 | 79 | 80 | ### fn withTimes 81 | 82 | ```jsonnet 83 | withTimes(value) 84 | ``` 85 | 86 | PARAMETERS: 87 | 88 | * **value** (`array`) 89 | 90 | 91 | ### fn withTimesMixin 92 | 93 | ```jsonnet 94 | withTimesMixin(value) 95 | ``` 96 | 97 | PARAMETERS: 98 | 99 | * **value** (`array`) 100 | 101 | 102 | ### fn withWeekdays 103 | 104 | ```jsonnet 105 | withWeekdays(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`array`) 111 | 112 | 113 | ### fn withWeekdaysMixin 114 | 115 | ```jsonnet 116 | withWeekdaysMixin(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`array`) 122 | 123 | 124 | ### fn withYears 125 | 126 | ```jsonnet 127 | withYears(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`array`) 133 | 134 | 135 | ### fn withYearsMixin 136 | 137 | ```jsonnet 138 | withYearsMixin(value) 139 | ``` 140 | 141 | PARAMETERS: 142 | 143 | * **value** (`array`) 144 | 145 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/muteTiming/interval/time_intervals/times.md: -------------------------------------------------------------------------------- 1 | # times 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withEndTime(value)`](#fn-withendtime) 8 | * [`fn withStartTime(value)`](#fn-withstarttime) 9 | 10 | ## Fields 11 | 12 | ### fn withEndTime 13 | 14 | ```jsonnet 15 | withEndTime(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withStartTime 24 | 25 | ```jsonnet 26 | withStartTime(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/notificationPolicy/matcher.md: -------------------------------------------------------------------------------- 1 | # matcher 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withType(value)`](#fn-withtype) 9 | * [`fn withValue(value)`](#fn-withvalue) 10 | 11 | ## Fields 12 | 13 | ### fn withName 14 | 15 | ```jsonnet 16 | withName(value) 17 | ``` 18 | 19 | PARAMETERS: 20 | 21 | * **value** (`string`) 22 | 23 | 24 | ### fn withType 25 | 26 | ```jsonnet 27 | withType(value) 28 | ``` 29 | 30 | PARAMETERS: 31 | 32 | * **value** (`string`) 33 | - valid values: `"="`, `"!="`, `"=~"`, `"!~"` 34 | 35 | 36 | ### fn withValue 37 | 38 | ```jsonnet 39 | withValue(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`string`) 45 | 46 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/notificationTemplate.md: -------------------------------------------------------------------------------- 1 | # notificationTemplate 2 | 3 | grafonnet.alerting.notificationTemplate 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withProvenance(value)`](#fn-withprovenance) 9 | * [`fn withTemplate(value)`](#fn-withtemplate) 10 | 11 | ## Fields 12 | 13 | ### fn withName 14 | 15 | ```jsonnet 16 | withName(value) 17 | ``` 18 | 19 | PARAMETERS: 20 | 21 | * **value** (`string`) 22 | 23 | 24 | ### fn withProvenance 25 | 26 | ```jsonnet 27 | withProvenance(value) 28 | ``` 29 | 30 | PARAMETERS: 31 | 32 | * **value** (`string`) 33 | 34 | 35 | ### fn withTemplate 36 | 37 | ```jsonnet 38 | withTemplate(value) 39 | ``` 40 | 41 | PARAMETERS: 42 | 43 | * **value** (`string`) 44 | 45 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/ruleGroup/index.md: -------------------------------------------------------------------------------- 1 | # ruleGroup 2 | 3 | grafonnet.alerting.ruleGroup 4 | 5 | ## Subpackages 6 | 7 | * [rule](rule/index.md) 8 | 9 | ## Index 10 | 11 | * [`fn withFolderUid(value)`](#fn-withfolderuid) 12 | * [`fn withInterval(value)`](#fn-withinterval) 13 | * [`fn withName(value)`](#fn-withname) 14 | * [`fn withRules(value)`](#fn-withrules) 15 | * [`fn withRulesMixin(value)`](#fn-withrulesmixin) 16 | 17 | ## Fields 18 | 19 | ### fn withFolderUid 20 | 21 | ```jsonnet 22 | withFolderUid(value) 23 | ``` 24 | 25 | PARAMETERS: 26 | 27 | * **value** (`string`) 28 | 29 | 30 | ### fn withInterval 31 | 32 | ```jsonnet 33 | withInterval(value) 34 | ``` 35 | 36 | PARAMETERS: 37 | 38 | * **value** (`integer`) 39 | 40 | Duration in seconds. 41 | ### fn withName 42 | 43 | ```jsonnet 44 | withName(value) 45 | ``` 46 | 47 | PARAMETERS: 48 | 49 | * **value** (`string`) 50 | 51 | 52 | ### fn withRules 53 | 54 | ```jsonnet 55 | withRules(value) 56 | ``` 57 | 58 | PARAMETERS: 59 | 60 | * **value** (`array`) 61 | 62 | 63 | ### fn withRulesMixin 64 | 65 | ```jsonnet 66 | withRulesMixin(value) 67 | ``` 68 | 69 | PARAMETERS: 70 | 71 | * **value** (`array`) 72 | 73 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/alerting/ruleGroup/rule/data.md: -------------------------------------------------------------------------------- 1 | # data 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withDatasourceUid(value)`](#fn-withdatasourceuid) 8 | * [`fn withModel(value)`](#fn-withmodel) 9 | * [`fn withModelMixin(value)`](#fn-withmodelmixin) 10 | * [`fn withQueryType(value)`](#fn-withquerytype) 11 | * [`fn withRefId(value)`](#fn-withrefid) 12 | * [`fn withRelativeTimeRange(value)`](#fn-withrelativetimerange) 13 | * [`fn withRelativeTimeRangeMixin(value)`](#fn-withrelativetimerangemixin) 14 | * [`obj relativeTimeRange`](#obj-relativetimerange) 15 | * [`fn withFrom(value)`](#fn-relativetimerangewithfrom) 16 | * [`fn withTo(value)`](#fn-relativetimerangewithto) 17 | 18 | ## Fields 19 | 20 | ### fn withDatasourceUid 21 | 22 | ```jsonnet 23 | withDatasourceUid(value) 24 | ``` 25 | 26 | PARAMETERS: 27 | 28 | * **value** (`string`) 29 | 30 | 31 | ### fn withModel 32 | 33 | ```jsonnet 34 | withModel(value) 35 | ``` 36 | 37 | PARAMETERS: 38 | 39 | * **value** (`object`) 40 | 41 | 42 | ### fn withModelMixin 43 | 44 | ```jsonnet 45 | withModelMixin(value) 46 | ``` 47 | 48 | PARAMETERS: 49 | 50 | * **value** (`object`) 51 | 52 | 53 | ### fn withQueryType 54 | 55 | ```jsonnet 56 | withQueryType(value) 57 | ``` 58 | 59 | PARAMETERS: 60 | 61 | * **value** (`string`) 62 | 63 | 64 | ### fn withRefId 65 | 66 | ```jsonnet 67 | withRefId(value) 68 | ``` 69 | 70 | PARAMETERS: 71 | 72 | * **value** (`string`) 73 | 74 | 75 | ### fn withRelativeTimeRange 76 | 77 | ```jsonnet 78 | withRelativeTimeRange(value) 79 | ``` 80 | 81 | PARAMETERS: 82 | 83 | * **value** (`object`) 84 | 85 | RelativeTimeRange is the per query start and end time 86 | for requests. 87 | ### fn withRelativeTimeRangeMixin 88 | 89 | ```jsonnet 90 | withRelativeTimeRangeMixin(value) 91 | ``` 92 | 93 | PARAMETERS: 94 | 95 | * **value** (`object`) 96 | 97 | RelativeTimeRange is the per query start and end time 98 | for requests. 99 | ### obj relativeTimeRange 100 | 101 | 102 | #### fn relativeTimeRange.withFrom 103 | 104 | ```jsonnet 105 | relativeTimeRange.withFrom(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`integer`) 111 | 112 | Duration in seconds. 113 | #### fn relativeTimeRange.withTo 114 | 115 | ```jsonnet 116 | relativeTimeRange.withTo(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`integer`) 122 | 123 | Duration in seconds. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/folder.md: -------------------------------------------------------------------------------- 1 | # folder 2 | 3 | grafonnet.folder 4 | 5 | ## Index 6 | 7 | * [`fn withParentUid(value)`](#fn-withparentuid) 8 | * [`fn withTitle(value)`](#fn-withtitle) 9 | * [`fn withUid(value)`](#fn-withuid) 10 | 11 | ## Fields 12 | 13 | ### fn withParentUid 14 | 15 | ```jsonnet 16 | withParentUid(value) 17 | ``` 18 | 19 | PARAMETERS: 20 | 21 | * **value** (`string`) 22 | 23 | only used if nested folders are enabled 24 | ### fn withTitle 25 | 26 | ```jsonnet 27 | withTitle(value) 28 | ``` 29 | 30 | PARAMETERS: 31 | 32 | * **value** (`string`) 33 | 34 | Folder title 35 | ### fn withUid 36 | 37 | ```jsonnet 38 | withUid(value) 39 | ``` 40 | 41 | PARAMETERS: 42 | 43 | * **value** (`string`) 44 | 45 | Unique folder id -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md: -------------------------------------------------------------------------------- 1 | # steps 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/librarypanel/model/fieldConfig/overrides/index.md: -------------------------------------------------------------------------------- 1 | # overrides 2 | 3 | 4 | 5 | ## Subpackages 6 | 7 | * [properties](properties.md) 8 | 9 | ## Index 10 | 11 | * [`fn withMatcher(value)`](#fn-withmatcher) 12 | * [`fn withMatcherMixin(value)`](#fn-withmatchermixin) 13 | * [`fn withProperties(value)`](#fn-withproperties) 14 | * [`fn withPropertiesMixin(value)`](#fn-withpropertiesmixin) 15 | * [`obj matcher`](#obj-matcher) 16 | * [`fn withId(value="")`](#fn-matcherwithid) 17 | * [`fn withOptions(value)`](#fn-matcherwithoptions) 18 | * [`fn withOptionsMixin(value)`](#fn-matcherwithoptionsmixin) 19 | 20 | ## Fields 21 | 22 | ### fn withMatcher 23 | 24 | ```jsonnet 25 | withMatcher(value) 26 | ``` 27 | 28 | PARAMETERS: 29 | 30 | * **value** (`object`) 31 | 32 | Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. 33 | It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. 34 | ### fn withMatcherMixin 35 | 36 | ```jsonnet 37 | withMatcherMixin(value) 38 | ``` 39 | 40 | PARAMETERS: 41 | 42 | * **value** (`object`) 43 | 44 | Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. 45 | It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. 46 | ### fn withProperties 47 | 48 | ```jsonnet 49 | withProperties(value) 50 | ``` 51 | 52 | PARAMETERS: 53 | 54 | * **value** (`array`) 55 | 56 | 57 | ### fn withPropertiesMixin 58 | 59 | ```jsonnet 60 | withPropertiesMixin(value) 61 | ``` 62 | 63 | PARAMETERS: 64 | 65 | * **value** (`array`) 66 | 67 | 68 | ### obj matcher 69 | 70 | 71 | #### fn matcher.withId 72 | 73 | ```jsonnet 74 | matcher.withId(value="") 75 | ``` 76 | 77 | PARAMETERS: 78 | 79 | * **value** (`string`) 80 | - default value: `""` 81 | 82 | The matcher id. This is used to find the matcher implementation from registry. 83 | #### fn matcher.withOptions 84 | 85 | ```jsonnet 86 | matcher.withOptions(value) 87 | ``` 88 | 89 | PARAMETERS: 90 | 91 | * **value** (`object`) 92 | 93 | The matcher options. This is specific to the matcher implementation. 94 | #### fn matcher.withOptionsMixin 95 | 96 | ```jsonnet 97 | matcher.withOptionsMixin(value) 98 | ``` 99 | 100 | PARAMETERS: 101 | 102 | * **value** (`object`) 103 | 104 | The matcher options. This is specific to the matcher implementation. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/librarypanel/model/fieldConfig/overrides/properties.md: -------------------------------------------------------------------------------- 1 | # properties 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withId(value="")`](#fn-withid) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | * [`fn withValueMixin(value)`](#fn-withvaluemixin) 10 | 11 | ## Fields 12 | 13 | ### fn withId 14 | 15 | ```jsonnet 16 | withId(value="") 17 | ``` 18 | 19 | PARAMETERS: 20 | 21 | * **value** (`string`) 22 | - default value: `""` 23 | 24 | 25 | ### fn withValue 26 | 27 | ```jsonnet 28 | withValue(value) 29 | ``` 30 | 31 | PARAMETERS: 32 | 33 | * **value** (`object`) 34 | 35 | 36 | ### fn withValueMixin 37 | 38 | ```jsonnet 39 | withValueMixin(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`object`) 45 | 46 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/librarypanel/model/links.md: -------------------------------------------------------------------------------- 1 | # links 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/alertList/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/annotationsList/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/barChart/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/barChart/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/barGauge/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/barGauge/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/candlestick/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/canvas/options/root/elements/connections/vertices.md: -------------------------------------------------------------------------------- 1 | # vertices 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withX(value)`](#fn-withx) 8 | * [`fn withY(value)`](#fn-withy) 9 | 10 | ## Fields 11 | 12 | ### fn withX 13 | 14 | ```jsonnet 15 | withX(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`number`) 21 | 22 | 23 | ### fn withY 24 | 25 | ```jsonnet 26 | withY(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/canvas/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/canvas/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/dashboardList/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/datagrid/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/datagrid/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/debug/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/debug/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/gauge/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/gauge/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/geomap/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/geomap/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/heatmap/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/heatmap/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/histogram/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/index.md: -------------------------------------------------------------------------------- 1 | # panel 2 | 3 | grafonnet.panel 4 | 5 | ## Subpackages 6 | 7 | * [alertList](alertList/index.md) 8 | * [annotationsList](annotationsList/index.md) 9 | * [barChart](barChart/index.md) 10 | * [barGauge](barGauge/index.md) 11 | * [candlestick](candlestick/index.md) 12 | * [canvas](canvas/index.md) 13 | * [dashboardList](dashboardList/index.md) 14 | * [datagrid](datagrid/index.md) 15 | * [debug](debug/index.md) 16 | * [gauge](gauge/index.md) 17 | * [geomap](geomap/index.md) 18 | * [heatmap](heatmap/index.md) 19 | * [histogram](histogram/index.md) 20 | * [logs](logs/index.md) 21 | * [news](news/index.md) 22 | * [nodeGraph](nodeGraph/index.md) 23 | * [pieChart](pieChart/index.md) 24 | * [row](row.md) 25 | * [stat](stat/index.md) 26 | * [stateTimeline](stateTimeline/index.md) 27 | * [statusHistory](statusHistory/index.md) 28 | * [table](table/index.md) 29 | * [text](text/index.md) 30 | * [timeSeries](timeSeries/index.md) 31 | * [trend](trend/index.md) 32 | * [xyChart](xyChart/index.md) 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/logs/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/logs/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/news/panelOptions/link.md: -------------------------------------------------------------------------------- 1 | # link 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAsDropdown(value=true)`](#fn-withasdropdown) 8 | * [`fn withIcon(value)`](#fn-withicon) 9 | * [`fn withIncludeVars(value=true)`](#fn-withincludevars) 10 | * [`fn withKeepTime(value=true)`](#fn-withkeeptime) 11 | * [`fn withTags(value)`](#fn-withtags) 12 | * [`fn withTagsMixin(value)`](#fn-withtagsmixin) 13 | * [`fn withTargetBlank(value=true)`](#fn-withtargetblank) 14 | * [`fn withTitle(value)`](#fn-withtitle) 15 | * [`fn withTooltip(value)`](#fn-withtooltip) 16 | * [`fn withType(value)`](#fn-withtype) 17 | * [`fn withUrl(value)`](#fn-withurl) 18 | 19 | ## Fields 20 | 21 | ### fn withAsDropdown 22 | 23 | ```jsonnet 24 | withAsDropdown(value=true) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`boolean`) 30 | - default value: `true` 31 | 32 | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards 33 | ### fn withIcon 34 | 35 | ```jsonnet 36 | withIcon(value) 37 | ``` 38 | 39 | PARAMETERS: 40 | 41 | * **value** (`string`) 42 | 43 | Icon name to be displayed with the link 44 | ### fn withIncludeVars 45 | 46 | ```jsonnet 47 | withIncludeVars(value=true) 48 | ``` 49 | 50 | PARAMETERS: 51 | 52 | * **value** (`boolean`) 53 | - default value: `true` 54 | 55 | If true, includes current template variables values in the link as query params 56 | ### fn withKeepTime 57 | 58 | ```jsonnet 59 | withKeepTime(value=true) 60 | ``` 61 | 62 | PARAMETERS: 63 | 64 | * **value** (`boolean`) 65 | - default value: `true` 66 | 67 | If true, includes current time range in the link as query params 68 | ### fn withTags 69 | 70 | ```jsonnet 71 | withTags(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`array`) 77 | 78 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 79 | ### fn withTagsMixin 80 | 81 | ```jsonnet 82 | withTagsMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`array`) 88 | 89 | List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards 90 | ### fn withTargetBlank 91 | 92 | ```jsonnet 93 | withTargetBlank(value=true) 94 | ``` 95 | 96 | PARAMETERS: 97 | 98 | * **value** (`boolean`) 99 | - default value: `true` 100 | 101 | If true, the link will be opened in a new tab 102 | ### fn withTitle 103 | 104 | ```jsonnet 105 | withTitle(value) 106 | ``` 107 | 108 | PARAMETERS: 109 | 110 | * **value** (`string`) 111 | 112 | Title to display with the link 113 | ### fn withTooltip 114 | 115 | ```jsonnet 116 | withTooltip(value) 117 | ``` 118 | 119 | PARAMETERS: 120 | 121 | * **value** (`string`) 122 | 123 | Tooltip to display when the user hovers their mouse over it 124 | ### fn withType 125 | 126 | ```jsonnet 127 | withType(value) 128 | ``` 129 | 130 | PARAMETERS: 131 | 132 | * **value** (`string`) 133 | - valid values: `"link"`, `"dashboards"` 134 | 135 | Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) 136 | ### fn withUrl 137 | 138 | ```jsonnet 139 | withUrl(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`string`) 145 | 146 | Link URL. Only required/valid if the type is link -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/news/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/nodeGraph/options/nodes/arcs.md: -------------------------------------------------------------------------------- 1 | # arcs 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withField(value)`](#fn-withfield) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | The color of the arc. 23 | ### fn withField 24 | 25 | ```jsonnet 26 | withField(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | Field from which to get the value. Values should be less than 1, representing fraction of a circle. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/nodeGraph/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/pieChart/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/stat/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/stateTimeline/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/statusHistory/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/table/options/sortBy.md: -------------------------------------------------------------------------------- 1 | # sortBy 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withDesc(value=true)`](#fn-withdesc) 8 | * [`fn withDisplayName(value)`](#fn-withdisplayname) 9 | 10 | ## Fields 11 | 12 | ### fn withDesc 13 | 14 | ```jsonnet 15 | withDesc(value=true) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`boolean`) 21 | - default value: `true` 22 | 23 | Flag used to indicate descending sort order 24 | ### fn withDisplayName 25 | 26 | ```jsonnet 27 | withDisplayName(value) 28 | ``` 29 | 30 | PARAMETERS: 31 | 32 | * **value** (`string`) 33 | 34 | Sets the display name of the field to sort by -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/table/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/text/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/timeSeries/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/trend/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/panel/xyChart/standardOptions/threshold/step.md: -------------------------------------------------------------------------------- 1 | # threshold.step 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withColor(value)`](#fn-withcolor) 8 | * [`fn withValue(value)`](#fn-withvalue) 9 | 10 | ## Fields 11 | 12 | ### fn withColor 13 | 14 | ```jsonnet 15 | withColor(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. 23 | ### fn withValue 24 | 25 | ```jsonnet 26 | withValue(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`number`) 32 | 33 | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. 34 | Nulls currently appear here when serializing -Infinity to JSON. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/publicdashboard.md: -------------------------------------------------------------------------------- 1 | # publicdashboard 2 | 3 | grafonnet.publicdashboard 4 | 5 | ## Index 6 | 7 | * [`fn withAccessToken(value)`](#fn-withaccesstoken) 8 | * [`fn withAnnotationsEnabled(value=true)`](#fn-withannotationsenabled) 9 | * [`fn withDashboardUid(value)`](#fn-withdashboarduid) 10 | * [`fn withIsEnabled(value=true)`](#fn-withisenabled) 11 | * [`fn withTimeSelectionEnabled(value=true)`](#fn-withtimeselectionenabled) 12 | * [`fn withUid(value)`](#fn-withuid) 13 | 14 | ## Fields 15 | 16 | ### fn withAccessToken 17 | 18 | ```jsonnet 19 | withAccessToken(value) 20 | ``` 21 | 22 | PARAMETERS: 23 | 24 | * **value** (`string`) 25 | 26 | Unique public access token 27 | ### fn withAnnotationsEnabled 28 | 29 | ```jsonnet 30 | withAnnotationsEnabled(value=true) 31 | ``` 32 | 33 | PARAMETERS: 34 | 35 | * **value** (`boolean`) 36 | - default value: `true` 37 | 38 | Flag that indicates if annotations are enabled 39 | ### fn withDashboardUid 40 | 41 | ```jsonnet 42 | withDashboardUid(value) 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`string`) 48 | 49 | Dashboard unique identifier referenced by this public dashboard 50 | ### fn withIsEnabled 51 | 52 | ```jsonnet 53 | withIsEnabled(value=true) 54 | ``` 55 | 56 | PARAMETERS: 57 | 58 | * **value** (`boolean`) 59 | - default value: `true` 60 | 61 | Flag that indicates if the public dashboard is enabled 62 | ### fn withTimeSelectionEnabled 63 | 64 | ```jsonnet 65 | withTimeSelectionEnabled(value=true) 66 | ``` 67 | 68 | PARAMETERS: 69 | 70 | * **value** (`boolean`) 71 | - default value: `true` 72 | 73 | Flag that indicates if the time range picker is enabled 74 | ### fn withUid 75 | 76 | ```jsonnet 77 | withUid(value) 78 | ``` 79 | 80 | PARAMETERS: 81 | 82 | * **value** (`string`) 83 | 84 | Unique public dashboard identifier -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md: -------------------------------------------------------------------------------- 1 | # dimensionFilters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withDimension(value)`](#fn-withdimension) 8 | * [`fn withFilter(value)`](#fn-withfilter) 9 | * [`fn withFilters(value)`](#fn-withfilters) 10 | * [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) 11 | * [`fn withOperator(value)`](#fn-withoperator) 12 | 13 | ## Fields 14 | 15 | ### fn withDimension 16 | 17 | ```jsonnet 18 | withDimension(value) 19 | ``` 20 | 21 | PARAMETERS: 22 | 23 | * **value** (`string`) 24 | 25 | Name of Dimension to be filtered on. 26 | ### fn withFilter 27 | 28 | ```jsonnet 29 | withFilter(value) 30 | ``` 31 | 32 | PARAMETERS: 33 | 34 | * **value** (`string`) 35 | 36 | @deprecated filter is deprecated in favour of filters to support multiselect. 37 | ### fn withFilters 38 | 39 | ```jsonnet 40 | withFilters(value) 41 | ``` 42 | 43 | PARAMETERS: 44 | 45 | * **value** (`array`) 46 | 47 | Values to match with the filter. 48 | ### fn withFiltersMixin 49 | 50 | ```jsonnet 51 | withFiltersMixin(value) 52 | ``` 53 | 54 | PARAMETERS: 55 | 56 | * **value** (`array`) 57 | 58 | Values to match with the filter. 59 | ### fn withOperator 60 | 61 | ```jsonnet 62 | withOperator(value) 63 | ``` 64 | 65 | PARAMETERS: 66 | 67 | * **value** (`string`) 68 | 69 | String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/azureMonitor/azureMonitor/resources.md: -------------------------------------------------------------------------------- 1 | # resources 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withMetricNamespace(value)`](#fn-withmetricnamespace) 8 | * [`fn withRegion(value)`](#fn-withregion) 9 | * [`fn withResourceGroup(value)`](#fn-withresourcegroup) 10 | * [`fn withResourceName(value)`](#fn-withresourcename) 11 | * [`fn withSubscription(value)`](#fn-withsubscription) 12 | 13 | ## Fields 14 | 15 | ### fn withMetricNamespace 16 | 17 | ```jsonnet 18 | withMetricNamespace(value) 19 | ``` 20 | 21 | PARAMETERS: 22 | 23 | * **value** (`string`) 24 | 25 | 26 | ### fn withRegion 27 | 28 | ```jsonnet 29 | withRegion(value) 30 | ``` 31 | 32 | PARAMETERS: 33 | 34 | * **value** (`string`) 35 | 36 | 37 | ### fn withResourceGroup 38 | 39 | ```jsonnet 40 | withResourceGroup(value) 41 | ``` 42 | 43 | PARAMETERS: 44 | 45 | * **value** (`string`) 46 | 47 | 48 | ### fn withResourceName 49 | 50 | ```jsonnet 51 | withResourceName(value) 52 | ``` 53 | 54 | PARAMETERS: 55 | 56 | * **value** (`string`) 57 | 58 | 59 | ### fn withSubscription 60 | 61 | ```jsonnet 62 | withSubscription(value) 63 | ``` 64 | 65 | PARAMETERS: 66 | 67 | * **value** (`string`) 68 | 69 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/azureMonitor/azureTraces/filters.md: -------------------------------------------------------------------------------- 1 | # filters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withFilters(value)`](#fn-withfilters) 8 | * [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) 9 | * [`fn withOperation(value)`](#fn-withoperation) 10 | * [`fn withProperty(value)`](#fn-withproperty) 11 | 12 | ## Fields 13 | 14 | ### fn withFilters 15 | 16 | ```jsonnet 17 | withFilters(value) 18 | ``` 19 | 20 | PARAMETERS: 21 | 22 | * **value** (`array`) 23 | 24 | Values to filter by. 25 | ### fn withFiltersMixin 26 | 27 | ```jsonnet 28 | withFiltersMixin(value) 29 | ``` 30 | 31 | PARAMETERS: 32 | 33 | * **value** (`array`) 34 | 35 | Values to filter by. 36 | ### fn withOperation 37 | 38 | ```jsonnet 39 | withOperation(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`string`) 45 | 46 | Comparison operator to use. Either equals or not equals. 47 | ### fn withProperty 48 | 49 | ```jsonnet 50 | withProperty(value) 51 | ``` 52 | 53 | PARAMETERS: 54 | 55 | * **value** (`string`) 56 | 57 | Property name, auto-populated based on available traces. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md: -------------------------------------------------------------------------------- 1 | # logGroups 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withAccountId(value)`](#fn-withaccountid) 8 | * [`fn withAccountLabel(value)`](#fn-withaccountlabel) 9 | * [`fn withArn(value)`](#fn-witharn) 10 | * [`fn withName(value)`](#fn-withname) 11 | 12 | ## Fields 13 | 14 | ### fn withAccountId 15 | 16 | ```jsonnet 17 | withAccountId(value) 18 | ``` 19 | 20 | PARAMETERS: 21 | 22 | * **value** (`string`) 23 | 24 | AccountId of the log group 25 | ### fn withAccountLabel 26 | 27 | ```jsonnet 28 | withAccountLabel(value) 29 | ``` 30 | 31 | PARAMETERS: 32 | 33 | * **value** (`string`) 34 | 35 | Label of the log group 36 | ### fn withArn 37 | 38 | ```jsonnet 39 | withArn(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`string`) 45 | 46 | ARN of the log group 47 | ### fn withName 48 | 49 | ```jsonnet 50 | withName(value) 51 | ``` 52 | 53 | PARAMETERS: 54 | 55 | * **value** (`string`) 56 | 57 | Name of the log group -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md: -------------------------------------------------------------------------------- 1 | # parameters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withType()`](#fn-withtype) 9 | 10 | ## Fields 11 | 12 | ### fn withName 13 | 14 | ```jsonnet 15 | withName(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withType 24 | 25 | ```jsonnet 26 | withType() 27 | ``` 28 | 29 | 30 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md: -------------------------------------------------------------------------------- 1 | # parameters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withType()`](#fn-withtype) 9 | 10 | ## Fields 11 | 12 | ### fn withName 13 | 14 | ```jsonnet 15 | withName(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withType 24 | 25 | ```jsonnet 26 | withType() 27 | ``` 28 | 29 | 30 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md: -------------------------------------------------------------------------------- 1 | # parameters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withType()`](#fn-withtype) 9 | 10 | ## Fields 11 | 12 | ### fn withName 13 | 14 | ```jsonnet 15 | withName(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withType 24 | 25 | ```jsonnet 26 | withType() 27 | ``` 28 | 29 | 30 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md: -------------------------------------------------------------------------------- 1 | # filters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withLabel(value)`](#fn-withlabel) 8 | * [`fn withQuery(value)`](#fn-withquery) 9 | 10 | ## Fields 11 | 12 | ### fn withLabel 13 | 14 | ```jsonnet 15 | withLabel(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withQuery 24 | 25 | ```jsonnet 26 | withQuery(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/elasticsearch/index.md: -------------------------------------------------------------------------------- 1 | # elasticsearch 2 | 3 | grafonnet.query.elasticsearch 4 | 5 | ## Subpackages 6 | 7 | * [bucketAggs](bucketAggs/index.md) 8 | * [metrics](metrics/index.md) 9 | 10 | ## Index 11 | 12 | * [`fn withAlias(value)`](#fn-withalias) 13 | * [`fn withBucketAggs(value)`](#fn-withbucketaggs) 14 | * [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) 15 | * [`fn withDatasource(value)`](#fn-withdatasource) 16 | * [`fn withHide(value=true)`](#fn-withhide) 17 | * [`fn withMetrics(value)`](#fn-withmetrics) 18 | * [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) 19 | * [`fn withQuery(value)`](#fn-withquery) 20 | * [`fn withQueryType(value)`](#fn-withquerytype) 21 | * [`fn withRefId(value)`](#fn-withrefid) 22 | * [`fn withTimeField(value)`](#fn-withtimefield) 23 | 24 | ## Fields 25 | 26 | ### fn withAlias 27 | 28 | ```jsonnet 29 | withAlias(value) 30 | ``` 31 | 32 | PARAMETERS: 33 | 34 | * **value** (`string`) 35 | 36 | Alias pattern 37 | ### fn withBucketAggs 38 | 39 | ```jsonnet 40 | withBucketAggs(value) 41 | ``` 42 | 43 | PARAMETERS: 44 | 45 | * **value** (`array`) 46 | 47 | List of bucket aggregations 48 | ### fn withBucketAggsMixin 49 | 50 | ```jsonnet 51 | withBucketAggsMixin(value) 52 | ``` 53 | 54 | PARAMETERS: 55 | 56 | * **value** (`array`) 57 | 58 | List of bucket aggregations 59 | ### fn withDatasource 60 | 61 | ```jsonnet 62 | withDatasource(value) 63 | ``` 64 | 65 | PARAMETERS: 66 | 67 | * **value** (`string`) 68 | 69 | Set the datasource for this query. 70 | ### fn withHide 71 | 72 | ```jsonnet 73 | withHide(value=true) 74 | ``` 75 | 76 | PARAMETERS: 77 | 78 | * **value** (`boolean`) 79 | - default value: `true` 80 | 81 | If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. 82 | ### fn withMetrics 83 | 84 | ```jsonnet 85 | withMetrics(value) 86 | ``` 87 | 88 | PARAMETERS: 89 | 90 | * **value** (`array`) 91 | 92 | List of metric aggregations 93 | ### fn withMetricsMixin 94 | 95 | ```jsonnet 96 | withMetricsMixin(value) 97 | ``` 98 | 99 | PARAMETERS: 100 | 101 | * **value** (`array`) 102 | 103 | List of metric aggregations 104 | ### fn withQuery 105 | 106 | ```jsonnet 107 | withQuery(value) 108 | ``` 109 | 110 | PARAMETERS: 111 | 112 | * **value** (`string`) 113 | 114 | Lucene query 115 | ### fn withQueryType 116 | 117 | ```jsonnet 118 | withQueryType(value) 119 | ``` 120 | 121 | PARAMETERS: 122 | 123 | * **value** (`string`) 124 | 125 | Specify the query flavor 126 | TODO make this required and give it a default 127 | ### fn withRefId 128 | 129 | ```jsonnet 130 | withRefId(value) 131 | ``` 132 | 133 | PARAMETERS: 134 | 135 | * **value** (`string`) 136 | 137 | A unique identifier for the query within the list of targets. 138 | In server side expressions, the refId is used as a variable name to identify results. 139 | By default, the UI will assign A->Z; however setting meaningful names may be useful. 140 | ### fn withTimeField 141 | 142 | ```jsonnet 143 | withTimeField(value) 144 | ``` 145 | 146 | PARAMETERS: 147 | 148 | * **value** (`string`) 149 | 150 | Name of time field -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md: -------------------------------------------------------------------------------- 1 | # pipelineVariables 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withPipelineAgg(value)`](#fn-withpipelineagg) 9 | 10 | ## Fields 11 | 12 | ### fn withName 13 | 14 | ```jsonnet 15 | withName(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withPipelineAgg 24 | 25 | ```jsonnet 26 | withPipelineAgg(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md: -------------------------------------------------------------------------------- 1 | # pipelineVariables 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withName(value)`](#fn-withname) 8 | * [`fn withPipelineAgg(value)`](#fn-withpipelineagg) 9 | 10 | ## Fields 11 | 12 | ### fn withName 13 | 14 | ```jsonnet 15 | withName(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | 23 | ### fn withPipelineAgg 24 | 25 | ```jsonnet 26 | withPipelineAgg(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/expr/TypeThreshold/conditions.md: -------------------------------------------------------------------------------- 1 | # conditions 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withEvaluator(value)`](#fn-withevaluator) 8 | * [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) 9 | * [`fn withLoadedDimensions(value)`](#fn-withloadeddimensions) 10 | * [`fn withLoadedDimensionsMixin(value)`](#fn-withloadeddimensionsmixin) 11 | * [`fn withUnloadEvaluator(value)`](#fn-withunloadevaluator) 12 | * [`fn withUnloadEvaluatorMixin(value)`](#fn-withunloadevaluatormixin) 13 | * [`obj evaluator`](#obj-evaluator) 14 | * [`fn withParams(value)`](#fn-evaluatorwithparams) 15 | * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) 16 | * [`fn withType(value)`](#fn-evaluatorwithtype) 17 | * [`obj unloadEvaluator`](#obj-unloadevaluator) 18 | * [`fn withParams(value)`](#fn-unloadevaluatorwithparams) 19 | * [`fn withParamsMixin(value)`](#fn-unloadevaluatorwithparamsmixin) 20 | * [`fn withType(value)`](#fn-unloadevaluatorwithtype) 21 | 22 | ## Fields 23 | 24 | ### fn withEvaluator 25 | 26 | ```jsonnet 27 | withEvaluator(value) 28 | ``` 29 | 30 | PARAMETERS: 31 | 32 | * **value** (`object`) 33 | 34 | 35 | ### fn withEvaluatorMixin 36 | 37 | ```jsonnet 38 | withEvaluatorMixin(value) 39 | ``` 40 | 41 | PARAMETERS: 42 | 43 | * **value** (`object`) 44 | 45 | 46 | ### fn withLoadedDimensions 47 | 48 | ```jsonnet 49 | withLoadedDimensions(value) 50 | ``` 51 | 52 | PARAMETERS: 53 | 54 | * **value** (`object`) 55 | 56 | 57 | ### fn withLoadedDimensionsMixin 58 | 59 | ```jsonnet 60 | withLoadedDimensionsMixin(value) 61 | ``` 62 | 63 | PARAMETERS: 64 | 65 | * **value** (`object`) 66 | 67 | 68 | ### fn withUnloadEvaluator 69 | 70 | ```jsonnet 71 | withUnloadEvaluator(value) 72 | ``` 73 | 74 | PARAMETERS: 75 | 76 | * **value** (`object`) 77 | 78 | 79 | ### fn withUnloadEvaluatorMixin 80 | 81 | ```jsonnet 82 | withUnloadEvaluatorMixin(value) 83 | ``` 84 | 85 | PARAMETERS: 86 | 87 | * **value** (`object`) 88 | 89 | 90 | ### obj evaluator 91 | 92 | 93 | #### fn evaluator.withParams 94 | 95 | ```jsonnet 96 | evaluator.withParams(value) 97 | ``` 98 | 99 | PARAMETERS: 100 | 101 | * **value** (`array`) 102 | 103 | 104 | #### fn evaluator.withParamsMixin 105 | 106 | ```jsonnet 107 | evaluator.withParamsMixin(value) 108 | ``` 109 | 110 | PARAMETERS: 111 | 112 | * **value** (`array`) 113 | 114 | 115 | #### fn evaluator.withType 116 | 117 | ```jsonnet 118 | evaluator.withType(value) 119 | ``` 120 | 121 | PARAMETERS: 122 | 123 | * **value** (`string`) 124 | - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` 125 | 126 | e.g. "gt" 127 | ### obj unloadEvaluator 128 | 129 | 130 | #### fn unloadEvaluator.withParams 131 | 132 | ```jsonnet 133 | unloadEvaluator.withParams(value) 134 | ``` 135 | 136 | PARAMETERS: 137 | 138 | * **value** (`array`) 139 | 140 | 141 | #### fn unloadEvaluator.withParamsMixin 142 | 143 | ```jsonnet 144 | unloadEvaluator.withParamsMixin(value) 145 | ``` 146 | 147 | PARAMETERS: 148 | 149 | * **value** (`array`) 150 | 151 | 152 | #### fn unloadEvaluator.withType 153 | 154 | ```jsonnet 155 | unloadEvaluator.withType(value) 156 | ``` 157 | 158 | PARAMETERS: 159 | 160 | * **value** (`string`) 161 | - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` 162 | 163 | e.g. "gt" -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/expr/index.md: -------------------------------------------------------------------------------- 1 | # expr 2 | 3 | Server Side Expression operations for grafonnet.alerting.ruleGroup.rule 4 | 5 | ## Subpackages 6 | 7 | * [TypeClassicConditions](TypeClassicConditions/index.md) 8 | * [TypeMath](TypeMath.md) 9 | * [TypeReduce](TypeReduce.md) 10 | * [TypeResample](TypeResample.md) 11 | * [TypeSql](TypeSql.md) 12 | * [TypeThreshold](TypeThreshold/index.md) 13 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/grafanaPyroscope.md: -------------------------------------------------------------------------------- 1 | # grafanaPyroscope 2 | 3 | grafonnet.query.grafanaPyroscope 4 | 5 | ## Index 6 | 7 | * [`fn withDatasource(value)`](#fn-withdatasource) 8 | * [`fn withGroupBy(value)`](#fn-withgroupby) 9 | * [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) 10 | * [`fn withHide(value=true)`](#fn-withhide) 11 | * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) 12 | * [`fn withMaxNodes(value)`](#fn-withmaxnodes) 13 | * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) 14 | * [`fn withQueryType(value)`](#fn-withquerytype) 15 | * [`fn withRefId(value)`](#fn-withrefid) 16 | * [`fn withSpanSelector(value)`](#fn-withspanselector) 17 | * [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) 18 | 19 | ## Fields 20 | 21 | ### fn withDatasource 22 | 23 | ```jsonnet 24 | withDatasource(value) 25 | ``` 26 | 27 | PARAMETERS: 28 | 29 | * **value** (`string`) 30 | 31 | Set the datasource for this query. 32 | ### fn withGroupBy 33 | 34 | ```jsonnet 35 | withGroupBy(value) 36 | ``` 37 | 38 | PARAMETERS: 39 | 40 | * **value** (`array`) 41 | 42 | Allows to group the results. 43 | ### fn withGroupByMixin 44 | 45 | ```jsonnet 46 | withGroupByMixin(value) 47 | ``` 48 | 49 | PARAMETERS: 50 | 51 | * **value** (`array`) 52 | 53 | Allows to group the results. 54 | ### fn withHide 55 | 56 | ```jsonnet 57 | withHide(value=true) 58 | ``` 59 | 60 | PARAMETERS: 61 | 62 | * **value** (`boolean`) 63 | - default value: `true` 64 | 65 | If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. 66 | ### fn withLabelSelector 67 | 68 | ```jsonnet 69 | withLabelSelector(value="{}") 70 | ``` 71 | 72 | PARAMETERS: 73 | 74 | * **value** (`string`) 75 | - default value: `"{}"` 76 | 77 | Specifies the query label selectors. 78 | ### fn withMaxNodes 79 | 80 | ```jsonnet 81 | withMaxNodes(value) 82 | ``` 83 | 84 | PARAMETERS: 85 | 86 | * **value** (`integer`) 87 | 88 | Sets the maximum number of nodes in the flamegraph. 89 | ### fn withProfileTypeId 90 | 91 | ```jsonnet 92 | withProfileTypeId(value) 93 | ``` 94 | 95 | PARAMETERS: 96 | 97 | * **value** (`string`) 98 | 99 | Specifies the type of profile to query. 100 | ### fn withQueryType 101 | 102 | ```jsonnet 103 | withQueryType(value) 104 | ``` 105 | 106 | PARAMETERS: 107 | 108 | * **value** (`string`) 109 | 110 | Specify the query flavor 111 | TODO make this required and give it a default 112 | ### fn withRefId 113 | 114 | ```jsonnet 115 | withRefId(value) 116 | ``` 117 | 118 | PARAMETERS: 119 | 120 | * **value** (`string`) 121 | 122 | A unique identifier for the query within the list of targets. 123 | In server side expressions, the refId is used as a variable name to identify results. 124 | By default, the UI will assign A->Z; however setting meaningful names may be useful. 125 | ### fn withSpanSelector 126 | 127 | ```jsonnet 128 | withSpanSelector(value) 129 | ``` 130 | 131 | PARAMETERS: 132 | 133 | * **value** (`array`) 134 | 135 | Specifies the query span selectors. 136 | ### fn withSpanSelectorMixin 137 | 138 | ```jsonnet 139 | withSpanSelectorMixin(value) 140 | ``` 141 | 142 | PARAMETERS: 143 | 144 | * **value** (`array`) 145 | 146 | Specifies the query span selectors. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/index.md: -------------------------------------------------------------------------------- 1 | # query 2 | 3 | grafonnet.query 4 | 5 | ## Subpackages 6 | 7 | * [azureMonitor](azureMonitor/index.md) 8 | * [cloudWatch](cloudWatch/index.md) 9 | * [elasticsearch](elasticsearch/index.md) 10 | * [expr](expr/index.md) 11 | * [googleCloudMonitoring](googleCloudMonitoring.md) 12 | * [grafanaPyroscope](grafanaPyroscope.md) 13 | * [loki](loki.md) 14 | * [parca](parca.md) 15 | * [prometheus](prometheus.md) 16 | * [tempo](tempo/index.md) 17 | * [testData](testData/index.md) 18 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/parca.md: -------------------------------------------------------------------------------- 1 | # parca 2 | 3 | grafonnet.query.parca 4 | 5 | ## Index 6 | 7 | * [`fn withDatasource(value)`](#fn-withdatasource) 8 | * [`fn withHide(value=true)`](#fn-withhide) 9 | * [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) 10 | * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) 11 | * [`fn withQueryType(value)`](#fn-withquerytype) 12 | * [`fn withRefId(value)`](#fn-withrefid) 13 | 14 | ## Fields 15 | 16 | ### fn withDatasource 17 | 18 | ```jsonnet 19 | withDatasource(value) 20 | ``` 21 | 22 | PARAMETERS: 23 | 24 | * **value** (`string`) 25 | 26 | Set the datasource for this query. 27 | ### fn withHide 28 | 29 | ```jsonnet 30 | withHide(value=true) 31 | ``` 32 | 33 | PARAMETERS: 34 | 35 | * **value** (`boolean`) 36 | - default value: `true` 37 | 38 | If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. 39 | ### fn withLabelSelector 40 | 41 | ```jsonnet 42 | withLabelSelector(value="{}") 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`string`) 48 | - default value: `"{}"` 49 | 50 | Specifies the query label selectors. 51 | ### fn withProfileTypeId 52 | 53 | ```jsonnet 54 | withProfileTypeId(value) 55 | ``` 56 | 57 | PARAMETERS: 58 | 59 | * **value** (`string`) 60 | 61 | Specifies the type of profile to query. 62 | ### fn withQueryType 63 | 64 | ```jsonnet 65 | withQueryType(value) 66 | ``` 67 | 68 | PARAMETERS: 69 | 70 | * **value** (`string`) 71 | 72 | Specify the query flavor 73 | TODO make this required and give it a default 74 | ### fn withRefId 75 | 76 | ```jsonnet 77 | withRefId(value) 78 | ``` 79 | 80 | PARAMETERS: 81 | 82 | * **value** (`string`) 83 | 84 | A unique identifier for the query within the list of targets. 85 | In server side expressions, the refId is used as a variable name to identify results. 86 | By default, the UI will assign A->Z; however setting meaningful names may be useful. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/tempo/filters.md: -------------------------------------------------------------------------------- 1 | # filters 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withId(value)`](#fn-withid) 8 | * [`fn withOperator(value)`](#fn-withoperator) 9 | * [`fn withScope(value)`](#fn-withscope) 10 | * [`fn withTag(value)`](#fn-withtag) 11 | * [`fn withValue(value)`](#fn-withvalue) 12 | * [`fn withValueMixin(value)`](#fn-withvaluemixin) 13 | * [`fn withValueType(value)`](#fn-withvaluetype) 14 | 15 | ## Fields 16 | 17 | ### fn withId 18 | 19 | ```jsonnet 20 | withId(value) 21 | ``` 22 | 23 | PARAMETERS: 24 | 25 | * **value** (`string`) 26 | 27 | Uniquely identify the filter, will not be used in the query generation 28 | ### fn withOperator 29 | 30 | ```jsonnet 31 | withOperator(value) 32 | ``` 33 | 34 | PARAMETERS: 35 | 36 | * **value** (`string`) 37 | 38 | The operator that connects the tag to the value, for example: =, >, !=, =~ 39 | ### fn withScope 40 | 41 | ```jsonnet 42 | withScope(value) 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`string`) 48 | - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` 49 | 50 | static fields are pre-set in the UI, dynamic fields are added by the user 51 | ### fn withTag 52 | 53 | ```jsonnet 54 | withTag(value) 55 | ``` 56 | 57 | PARAMETERS: 58 | 59 | * **value** (`string`) 60 | 61 | The tag for the search filter, for example: .http.status_code, .service.name, status 62 | ### fn withValue 63 | 64 | ```jsonnet 65 | withValue(value) 66 | ``` 67 | 68 | PARAMETERS: 69 | 70 | * **value** (`array`,`string`) 71 | 72 | The value for the search filter 73 | ### fn withValueMixin 74 | 75 | ```jsonnet 76 | withValueMixin(value) 77 | ``` 78 | 79 | PARAMETERS: 80 | 81 | * **value** (`array`,`string`) 82 | 83 | The value for the search filter 84 | ### fn withValueType 85 | 86 | ```jsonnet 87 | withValueType(value) 88 | ``` 89 | 90 | PARAMETERS: 91 | 92 | * **value** (`string`) 93 | 94 | The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/tempo/groupBy.md: -------------------------------------------------------------------------------- 1 | # groupBy 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withId(value)`](#fn-withid) 8 | * [`fn withOperator(value)`](#fn-withoperator) 9 | * [`fn withScope(value)`](#fn-withscope) 10 | * [`fn withTag(value)`](#fn-withtag) 11 | * [`fn withValue(value)`](#fn-withvalue) 12 | * [`fn withValueMixin(value)`](#fn-withvaluemixin) 13 | * [`fn withValueType(value)`](#fn-withvaluetype) 14 | 15 | ## Fields 16 | 17 | ### fn withId 18 | 19 | ```jsonnet 20 | withId(value) 21 | ``` 22 | 23 | PARAMETERS: 24 | 25 | * **value** (`string`) 26 | 27 | Uniquely identify the filter, will not be used in the query generation 28 | ### fn withOperator 29 | 30 | ```jsonnet 31 | withOperator(value) 32 | ``` 33 | 34 | PARAMETERS: 35 | 36 | * **value** (`string`) 37 | 38 | The operator that connects the tag to the value, for example: =, >, !=, =~ 39 | ### fn withScope 40 | 41 | ```jsonnet 42 | withScope(value) 43 | ``` 44 | 45 | PARAMETERS: 46 | 47 | * **value** (`string`) 48 | - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` 49 | 50 | static fields are pre-set in the UI, dynamic fields are added by the user 51 | ### fn withTag 52 | 53 | ```jsonnet 54 | withTag(value) 55 | ``` 56 | 57 | PARAMETERS: 58 | 59 | * **value** (`string`) 60 | 61 | The tag for the search filter, for example: .http.status_code, .service.name, status 62 | ### fn withValue 63 | 64 | ```jsonnet 65 | withValue(value) 66 | ``` 67 | 68 | PARAMETERS: 69 | 70 | * **value** (`array`,`string`) 71 | 72 | The value for the search filter 73 | ### fn withValueMixin 74 | 75 | ```jsonnet 76 | withValueMixin(value) 77 | ``` 78 | 79 | PARAMETERS: 80 | 81 | * **value** (`array`,`string`) 82 | 83 | The value for the search filter 84 | ### fn withValueType 85 | 86 | ```jsonnet 87 | withValueType(value) 88 | ``` 89 | 90 | PARAMETERS: 91 | 92 | * **value** (`string`) 93 | 94 | The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/query/testData/csvWave.md: -------------------------------------------------------------------------------- 1 | # csvWave 2 | 3 | 4 | 5 | ## Index 6 | 7 | * [`fn withLabels(value)`](#fn-withlabels) 8 | * [`fn withName(value)`](#fn-withname) 9 | * [`fn withTimeStep(value)`](#fn-withtimestep) 10 | * [`fn withValuesCSV(value)`](#fn-withvaluescsv) 11 | 12 | ## Fields 13 | 14 | ### fn withLabels 15 | 16 | ```jsonnet 17 | withLabels(value) 18 | ``` 19 | 20 | PARAMETERS: 21 | 22 | * **value** (`string`) 23 | 24 | 25 | ### fn withName 26 | 27 | ```jsonnet 28 | withName(value) 29 | ``` 30 | 31 | PARAMETERS: 32 | 33 | * **value** (`string`) 34 | 35 | 36 | ### fn withTimeStep 37 | 38 | ```jsonnet 39 | withTimeStep(value) 40 | ``` 41 | 42 | PARAMETERS: 43 | 44 | * **value** (`integer`) 45 | 46 | 47 | ### fn withValuesCSV 48 | 49 | ```jsonnet 50 | withValuesCSV(value) 51 | ``` 52 | 53 | PARAMETERS: 54 | 55 | * **value** (`string`) 56 | 57 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/role.md: -------------------------------------------------------------------------------- 1 | # role 2 | 3 | grafonnet.role 4 | 5 | ## Index 6 | 7 | * [`fn withDescription(value)`](#fn-withdescription) 8 | * [`fn withDisplayName(value)`](#fn-withdisplayname) 9 | * [`fn withGroupName(value)`](#fn-withgroupname) 10 | * [`fn withHidden(value=true)`](#fn-withhidden) 11 | * [`fn withName(value)`](#fn-withname) 12 | 13 | ## Fields 14 | 15 | ### fn withDescription 16 | 17 | ```jsonnet 18 | withDescription(value) 19 | ``` 20 | 21 | PARAMETERS: 22 | 23 | * **value** (`string`) 24 | 25 | Role description 26 | ### fn withDisplayName 27 | 28 | ```jsonnet 29 | withDisplayName(value) 30 | ``` 31 | 32 | PARAMETERS: 33 | 34 | * **value** (`string`) 35 | 36 | Optional display 37 | ### fn withGroupName 38 | 39 | ```jsonnet 40 | withGroupName(value) 41 | ``` 42 | 43 | PARAMETERS: 44 | 45 | * **value** (`string`) 46 | 47 | Name of the team. 48 | ### fn withHidden 49 | 50 | ```jsonnet 51 | withHidden(value=true) 52 | ``` 53 | 54 | PARAMETERS: 55 | 56 | * **value** (`boolean`) 57 | - default value: `true` 58 | 59 | Do not show this role 60 | ### fn withName 61 | 62 | ```jsonnet 63 | withName(value) 64 | ``` 65 | 66 | PARAMETERS: 67 | 68 | * **value** (`string`) 69 | 70 | The role identifier `managed:builtins:editor:permissions` -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/docs/team.md: -------------------------------------------------------------------------------- 1 | # team 2 | 3 | grafonnet.team 4 | 5 | ## Index 6 | 7 | * [`fn withEmail(value)`](#fn-withemail) 8 | * [`fn withName(value)`](#fn-withname) 9 | 10 | ## Fields 11 | 12 | ### fn withEmail 13 | 14 | ```jsonnet 15 | withEmail(value) 16 | ``` 17 | 18 | PARAMETERS: 19 | 20 | * **value** (`string`) 21 | 22 | Email of the team. 23 | ### fn withName 24 | 25 | ```jsonnet 26 | withName(value) 27 | ``` 28 | 29 | PARAMETERS: 30 | 31 | * **value** (`string`) 32 | 33 | Name of the team. -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/folder.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.folder', name: 'folder' }, 4 | '#withParentUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'only used if nested folders are enabled' } }, 5 | withParentUid(value): { 6 | parentUid: value, 7 | }, 8 | '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder title' } }, 9 | withTitle(value): { 10 | title: value, 11 | }, 12 | '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique folder id' } }, 13 | withUid(value): { 14 | uid: value, 15 | }, 16 | } 17 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/jsonnetfile.json: -------------------------------------------------------------------------------- 1 | { 2 | "dependencies": [ 3 | { 4 | "source": { 5 | "git": { 6 | "remote": "https://github.com/jsonnet-libs/docsonnet.git", 7 | "subdir": "doc-util" 8 | } 9 | }, 10 | "version": "master" 11 | }, 12 | { 13 | "source": { 14 | "git": { 15 | "remote": "https://github.com/jsonnet-libs/xtd.git", 16 | "subdir": "" 17 | } 18 | }, 19 | "version": "master" 20 | } 21 | ], 22 | "legacyImports": true, 23 | "version": 1 24 | } -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { 4 | filename: 'main.libsonnet', 5 | help: 'Jsonnet library for rendering Grafana resources\n## Install\n\n```\njb install github.com/grafana/grafonnet/gen/grafonnet-v11.1.0@main\n```\n\n## Usage\n\n```jsonnet\nlocal grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet"\n```\n', 6 | 'import': 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet', 7 | installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', 8 | name: 'grafonnet', 9 | url: 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0', 10 | usageTemplate: '\n## Usage\n\n```jsonnet\nlocal %(name)s = import "%(import)s"\n```\n', 11 | version: 'main', 12 | }, 13 | accesspolicy: import 'accesspolicy.libsonnet', 14 | dashboard: import 'dashboard.libsonnet', 15 | librarypanel: import 'librarypanel.libsonnet', 16 | preferences: import 'preferences.libsonnet', 17 | publicdashboard: import 'publicdashboard.libsonnet', 18 | role: import 'role.libsonnet', 19 | rolebinding: import 'rolebinding.libsonnet', 20 | team: import 'team.libsonnet', 21 | folder: import 'folder.libsonnet', 22 | panel: import 'panelindex.libsonnet', 23 | query: import 'query.libsonnet', 24 | util: import 'custom/util/main.libsonnet', 25 | alerting: import 'alerting.libsonnet', 26 | } 27 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panel/datagrid.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | (import '../panel.libsonnet') 3 | + { 4 | '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, 5 | panelOptions+: 6 | { 7 | '#withType': { 'function': { args: [], help: '' } }, 8 | withType(): { 9 | type: 'datagrid', 10 | }, 11 | }, 12 | options+: 13 | { 14 | '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, 15 | withSelectedSeries(value=0): { 16 | options+: { 17 | selectedSeries: value, 18 | }, 19 | }, 20 | }, 21 | } 22 | + { 23 | panelOptions+: { 24 | '#withType':: { 25 | ignore: true, 26 | }, 27 | }, 28 | } 29 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panel/debug.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | (import '../panel.libsonnet') 3 | + { 4 | '#': { help: 'grafonnet.panel.debug', name: 'debug' }, 5 | panelOptions+: 6 | { 7 | '#withType': { 'function': { args: [], help: '' } }, 8 | withType(): { 9 | type: 'debug', 10 | }, 11 | }, 12 | options+: 13 | { 14 | '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, 15 | withCounters(value): { 16 | options+: { 17 | counters: value, 18 | }, 19 | }, 20 | '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, 21 | withCountersMixin(value): { 22 | options+: { 23 | counters+: value, 24 | }, 25 | }, 26 | counters+: 27 | { 28 | '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 29 | withDataChanged(value=true): { 30 | options+: { 31 | counters+: { 32 | dataChanged: value, 33 | }, 34 | }, 35 | }, 36 | '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 37 | withRender(value=true): { 38 | options+: { 39 | counters+: { 40 | render: value, 41 | }, 42 | }, 43 | }, 44 | '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 45 | withSchemaChanged(value=true): { 46 | options+: { 47 | counters+: { 48 | schemaChanged: value, 49 | }, 50 | }, 51 | }, 52 | }, 53 | '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, 54 | withMode(value): { 55 | options+: { 56 | mode: value, 57 | }, 58 | }, 59 | }, 60 | } 61 | + { 62 | panelOptions+: { 63 | '#withType':: { 64 | ignore: true, 65 | }, 66 | }, 67 | } 68 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panel/logs.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | (import '../panel.libsonnet') 3 | + { 4 | '#': { help: 'grafonnet.panel.logs', name: 'logs' }, 5 | panelOptions+: 6 | { 7 | '#withType': { 'function': { args: [], help: '' } }, 8 | withType(): { 9 | type: 'logs', 10 | }, 11 | }, 12 | options+: 13 | { 14 | '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, 15 | withDedupStrategy(value): { 16 | options+: { 17 | dedupStrategy: value, 18 | }, 19 | }, 20 | '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 21 | withEnableLogDetails(value=true): { 22 | options+: { 23 | enableLogDetails: value, 24 | }, 25 | }, 26 | '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 27 | withPrettifyLogMessage(value=true): { 28 | options+: { 29 | prettifyLogMessage: value, 30 | }, 31 | }, 32 | '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 33 | withShowCommonLabels(value=true): { 34 | options+: { 35 | showCommonLabels: value, 36 | }, 37 | }, 38 | '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 39 | withShowLabels(value=true): { 40 | options+: { 41 | showLabels: value, 42 | }, 43 | }, 44 | '#withShowLogContextToggle': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 45 | withShowLogContextToggle(value=true): { 46 | options+: { 47 | showLogContextToggle: value, 48 | }, 49 | }, 50 | '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 51 | withShowTime(value=true): { 52 | options+: { 53 | showTime: value, 54 | }, 55 | }, 56 | '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, 57 | withSortOrder(value): { 58 | options+: { 59 | sortOrder: value, 60 | }, 61 | }, 62 | '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 63 | withWrapLogMessage(value=true): { 64 | options+: { 65 | wrapLogMessage: value, 66 | }, 67 | }, 68 | }, 69 | } 70 | + { 71 | panelOptions+: { 72 | '#withType':: { 73 | ignore: true, 74 | }, 75 | }, 76 | } 77 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panel/news.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | (import '../panel.libsonnet') 3 | + { 4 | '#': { help: 'grafonnet.panel.news', name: 'news' }, 5 | panelOptions+: 6 | { 7 | '#withType': { 'function': { args: [], help: '' } }, 8 | withType(): { 9 | type: 'news', 10 | }, 11 | }, 12 | options+: 13 | { 14 | '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, 15 | withFeedUrl(value): { 16 | options+: { 17 | feedUrl: value, 18 | }, 19 | }, 20 | '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 21 | withShowImage(value=true): { 22 | options+: { 23 | showImage: value, 24 | }, 25 | }, 26 | }, 27 | } 28 | + { 29 | panelOptions+: { 30 | '#withType':: { 31 | ignore: true, 32 | }, 33 | }, 34 | } 35 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panel/text.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | (import '../panel.libsonnet') 3 | + { 4 | '#': { help: 'grafonnet.panel.text', name: 'text' }, 5 | panelOptions+: 6 | { 7 | '#withType': { 'function': { args: [], help: '' } }, 8 | withType(): { 9 | type: 'text', 10 | }, 11 | }, 12 | options+: 13 | { 14 | '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, 15 | withCode(value): { 16 | options+: { 17 | code: value, 18 | }, 19 | }, 20 | '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, 21 | withCodeMixin(value): { 22 | options+: { 23 | code+: value, 24 | }, 25 | }, 26 | code+: 27 | { 28 | '#withLanguage': { 'function': { args: [{ default: 'plaintext', enums: ['json', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'plaintext'], name: 'value', type: ['string'] }], help: 'The language passed to monaco code editor' } }, 29 | withLanguage(value='plaintext'): { 30 | options+: { 31 | code+: { 32 | language: value, 33 | }, 34 | }, 35 | }, 36 | '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 37 | withShowLineNumbers(value=true): { 38 | options+: { 39 | code+: { 40 | showLineNumbers: value, 41 | }, 42 | }, 43 | }, 44 | '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, 45 | withShowMiniMap(value=true): { 46 | options+: { 47 | code+: { 48 | showMiniMap: value, 49 | }, 50 | }, 51 | }, 52 | }, 53 | '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, 54 | withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { 55 | options+: { 56 | content: value, 57 | }, 58 | }, 59 | '#withMode': { 'function': { args: [{ default: 'markdown', enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, 60 | withMode(value='markdown'): { 61 | options+: { 62 | mode: value, 63 | }, 64 | }, 65 | }, 66 | } 67 | + { 68 | panelOptions+: { 69 | '#withType':: { 70 | ignore: true, 71 | }, 72 | }, 73 | } 74 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/panelindex.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.panel', name: 'panel' }, 4 | alertList: import 'panel/alertList.libsonnet', 5 | annotationsList: import 'panel/annotationsList.libsonnet', 6 | barChart: import 'panel/barChart.libsonnet', 7 | barGauge: import 'panel/barGauge.libsonnet', 8 | candlestick: import 'panel/candlestick.libsonnet', 9 | canvas: import 'panel/canvas.libsonnet', 10 | dashboardList: import 'panel/dashboardList.libsonnet', 11 | datagrid: import 'panel/datagrid.libsonnet', 12 | debug: import 'panel/debug.libsonnet', 13 | gauge: import 'panel/gauge.libsonnet', 14 | geomap: import 'panel/geomap.libsonnet', 15 | heatmap: import 'panel/heatmap.libsonnet', 16 | histogram: import 'panel/histogram.libsonnet', 17 | logs: import 'panel/logs.libsonnet', 18 | news: import 'panel/news.libsonnet', 19 | nodeGraph: import 'panel/nodeGraph.libsonnet', 20 | pieChart: import 'panel/pieChart.libsonnet', 21 | stat: import 'panel/stat.libsonnet', 22 | stateTimeline: import 'panel/stateTimeline.libsonnet', 23 | statusHistory: import 'panel/statusHistory.libsonnet', 24 | table: import 'panel/table.libsonnet', 25 | text: import 'panel/text.libsonnet', 26 | timeSeries: import 'panel/timeSeries.libsonnet', 27 | trend: import 'panel/trend.libsonnet', 28 | xyChart: import 'panel/xyChart.libsonnet', 29 | row: import 'panel/row.libsonnet', 30 | } 31 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/publicdashboard.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.publicdashboard', name: 'publicdashboard' }, 4 | '#withAccessToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public access token' } }, 5 | withAccessToken(value): { 6 | accessToken: value, 7 | }, 8 | '#withAnnotationsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if annotations are enabled' } }, 9 | withAnnotationsEnabled(value=true): { 10 | annotationsEnabled: value, 11 | }, 12 | '#withDashboardUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Dashboard unique identifier referenced by this public dashboard' } }, 13 | withDashboardUid(value): { 14 | dashboardUid: value, 15 | }, 16 | '#withIsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the public dashboard is enabled' } }, 17 | withIsEnabled(value=true): { 18 | isEnabled: value, 19 | }, 20 | '#withTimeSelectionEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the time range picker is enabled' } }, 21 | withTimeSelectionEnabled(value=true): { 22 | timeSelectionEnabled: value, 23 | }, 24 | '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public dashboard identifier' } }, 25 | withUid(value): { 26 | uid: value, 27 | }, 28 | } 29 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/query.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.query', name: 'query' }, 4 | azureMonitor: import 'query/azureMonitor.libsonnet', 5 | cloudWatch: import 'query/cloudWatch.libsonnet', 6 | elasticsearch: import 'query/elasticsearch.libsonnet', 7 | expr: import 'query/expr.libsonnet', 8 | googleCloudMonitoring: import 'query/googleCloudMonitoring.libsonnet', 9 | grafanaPyroscope: import 'query/grafanaPyroscope.libsonnet', 10 | loki: import 'query/loki.libsonnet', 11 | parca: import 'query/parca.libsonnet', 12 | prometheus: import 'query/prometheus.libsonnet', 13 | tempo: import 'query/tempo.libsonnet', 14 | testData: import 'query/testData.libsonnet', 15 | } 16 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/query/parca.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.query.parca', name: 'parca' }, 4 | '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, 5 | withDatasource(value): { 6 | datasource: value, 7 | }, 8 | '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, 9 | withDatasourceMixin(value): { 10 | datasource+: value, 11 | }, 12 | '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, 13 | withHide(value=true): { 14 | hide: value, 15 | }, 16 | '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, 17 | withLabelSelector(value='{}'): { 18 | labelSelector: value, 19 | }, 20 | '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, 21 | withProfileTypeId(value): { 22 | profileTypeId: value, 23 | }, 24 | '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, 25 | withQueryType(value): { 26 | queryType: value, 27 | }, 28 | '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, 29 | withRefId(value): { 30 | refId: value, 31 | }, 32 | } 33 | + (import '../custom/query/parca.libsonnet') 34 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/role.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.role', name: 'role' }, 4 | '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Role description' } }, 5 | withDescription(value): { 6 | description: value, 7 | }, 8 | '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display' } }, 9 | withDisplayName(value): { 10 | displayName: value, 11 | }, 12 | '#withGroupName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, 13 | withGroupName(value): { 14 | groupName: value, 15 | }, 16 | '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Do not show this role' } }, 17 | withHidden(value=true): { 18 | hidden: value, 19 | }, 20 | '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, 21 | withName(value): { 22 | name: value, 23 | }, 24 | } 25 | -------------------------------------------------------------------------------- /vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/team.libsonnet: -------------------------------------------------------------------------------- 1 | // This file is generated, do not manually edit. 2 | { 3 | '#': { help: 'grafonnet.team', name: 'team' }, 4 | '#withEmail': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Email of the team.' } }, 5 | withEmail(value): { 6 | email: value, 7 | }, 8 | '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, 9 | withName(value): { 10 | name: value, 11 | }, 12 | } 13 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: tests 2 | on: 3 | pull_request: {} 4 | push: 5 | branches: 6 | - main 7 | - master 8 | 9 | jobs: 10 | test: 11 | name: test 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v4 15 | - uses: actions/setup-go@v4 16 | - name: make test 17 | run: | 18 | go install github.com/google/go-jsonnet/cmd/jsonnet@latest 19 | go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest 20 | make test 21 | docs: 22 | name: docs 23 | runs-on: ubuntu-latest 24 | steps: 25 | - uses: actions/checkout@v4 26 | - uses: actions/setup-go@v4 27 | - name: make docs 28 | run: | 29 | go install github.com/jsonnet-libs/docsonnet@master 30 | make docs 31 | git diff --exit-code 32 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/.gitignore: -------------------------------------------------------------------------------- 1 | .jekyll-cache 2 | jsonnetfile.lock.json 3 | vendor 4 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: test 2 | test: 3 | @cd test/; \ 4 | jb install; \ 5 | RESULT=0; \ 6 | for f in $$(find . -path './.git' -prune -o -name 'vendor' -prune -o -name '*_test.jsonnet' -print); do \ 7 | echo "$$f"; \ 8 | jsonnet -J vendor -J lib "$$f"; \ 9 | RESULT=$$(($$RESULT + $$?)); \ 10 | done; \ 11 | exit $$RESULT 12 | 13 | 14 | .PHONY: docs 15 | docs: 16 | docsonnet main.libsonnet 17 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/README.md: -------------------------------------------------------------------------------- 1 | # `xtd` 2 | 3 | `xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). 4 | 5 | ## Install 6 | 7 | ```console 8 | jb install github.com/jsonnet-libs/xtd 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```jsonnet 14 | local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" 15 | ``` 16 | 17 | ## Docs 18 | 19 | [docs](docs/README.md) 20 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | local this = self, 5 | 6 | '#': d.pkg( 7 | name='aggregate', 8 | url='github.com/jsonnet-libs/xtd/aggregate.libsonnet', 9 | help=||| 10 | `aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. 11 | 12 | Example: 13 | 14 | ```jsonnet 15 | local apps = [ 16 | { 17 | appid: 'id1', 18 | name: 'yo', 19 | id: i, 20 | } 21 | for i in std.range(0, 10) 22 | ]; 23 | 24 | aggregate.byKeys(apps, ['appid', 'name']); 25 | ``` 26 | 27 | Output: 28 | 29 | ```json 30 | { 31 | "id1": { 32 | "yo": [ 33 | { 34 | "appid": "id1", 35 | "id": 0, 36 | "name": "yo" 37 | }, 38 | { 39 | "appid": "id1", 40 | "id": 1, 41 | "name": "yo" 42 | }, 43 | ... 44 | ] 45 | } 46 | } 47 | ``` 48 | |||, 49 | ), 50 | 51 | '#byKey':: d.fn( 52 | ||| 53 | `byKey` aggregates an array by the value of `key` 54 | |||, 55 | [ 56 | d.arg('arr', d.T.array), 57 | d.arg('key', d.T.string), 58 | ] 59 | ), 60 | byKey(arr, key): 61 | // find all values of key 62 | local values = std.set([ 63 | item[key] 64 | for item in arr 65 | ]); 66 | 67 | // create the aggregate for the value of each key 68 | { 69 | [value]: [ 70 | item 71 | for item in std.filter( 72 | function(x) 73 | x[key] == value, 74 | arr 75 | ) 76 | ] 77 | for value in values 78 | }, 79 | 80 | '#byKeys':: d.fn( 81 | ||| 82 | `byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the 83 | aggregate one layer deeper. 84 | |||, 85 | [ 86 | d.arg('arr', d.T.array), 87 | d.arg('keys', d.T.array), 88 | ] 89 | ), 90 | byKeys(arr, keys): 91 | local aggregate = self.byKey(arr, keys[0]); 92 | // if last key in keys 93 | if std.length(keys) == 1 94 | 95 | // then return aggregate 96 | then aggregate 97 | 98 | // else aggregate with remaining keys 99 | else { 100 | [k]: this.byKeys(aggregate[k], keys[1:]) 101 | for k in std.objectFields(aggregate) 102 | }, 103 | 104 | } 105 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/array.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#': d.pkg( 5 | name='array', 6 | url='github.com/jsonnet-libs/xtd/array.libsonnet', 7 | help='`array` implements helper functions for processing arrays.', 8 | ), 9 | 10 | '#slice':: d.fn( 11 | '`slice` works the same as `std.slice` but with support for negative index/end.', 12 | [ 13 | d.arg('indexable', d.T.array), 14 | d.arg('index', d.T.number), 15 | d.arg('end', d.T.number, default='null'), 16 | d.arg('step', d.T.number, default=1), 17 | ] 18 | ), 19 | slice(indexable, index, end=null, step=1): 20 | local invar = { 21 | index: 22 | if index != null 23 | then 24 | if index < 0 25 | then std.length(indexable) + index 26 | else index 27 | else 0, 28 | end: 29 | if end != null 30 | then 31 | if end < 0 32 | then std.length(indexable) + end 33 | else end 34 | else std.length(indexable), 35 | }; 36 | indexable[invar.index:invar.end:step], 37 | 38 | '#filterMapWithIndex':: d.fn( 39 | ||| 40 | `filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. 41 | 42 | `filter_func` and `map_func` function signature: `function(index, array_item)` 43 | |||, 44 | [ 45 | d.arg('filter_func', d.T.func), 46 | d.arg('map_func', d.T.func), 47 | d.arg('arr', d.T.array), 48 | ], 49 | ), 50 | filterMapWithIndex(filter_func, map_func, arr): [ 51 | map_func(i, arr[i]) 52 | for i in std.range(0, std.length(arr) - 1) 53 | if filter_func(i, arr[i]) 54 | ], 55 | } 56 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/.gitignore: -------------------------------------------------------------------------------- 1 | Gemfile.lock 2 | _site 3 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | gem "github-pages", group: :jekyll_plugins 3 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/README.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: / 3 | --- 4 | 5 | # xtd 6 | 7 | ```jsonnet 8 | local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" 9 | ``` 10 | 11 | `xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). 12 | 13 | This package serves as a test field for functions intended to be contributed to `std` 14 | in the future, but also provides a place for less general, yet useful utilities. 15 | 16 | 17 | * [aggregate](aggregate.md) 18 | * [array](array.md) 19 | * [ascii](ascii.md) 20 | * [camelcase](camelcase.md) 21 | * [date](date.md) 22 | * [inspect](inspect.md) 23 | * [jsonpath](jsonpath.md) 24 | * [number](number.md) 25 | * [string](string.md) 26 | * [url](url.md) -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman 2 | baseurl: /xtd 3 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /aggregate/ 3 | --- 4 | 5 | # aggregate 6 | 7 | ```jsonnet 8 | local aggregate = import "github.com/jsonnet-libs/xtd/aggregate.libsonnet" 9 | ``` 10 | 11 | `aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. 12 | 13 | Example: 14 | 15 | ```jsonnet 16 | local apps = [ 17 | { 18 | appid: 'id1', 19 | name: 'yo', 20 | id: i, 21 | } 22 | for i in std.range(0, 10) 23 | ]; 24 | 25 | aggregate.byKeys(apps, ['appid', 'name']); 26 | ``` 27 | 28 | Output: 29 | 30 | ```json 31 | { 32 | "id1": { 33 | "yo": [ 34 | { 35 | "appid": "id1", 36 | "id": 0, 37 | "name": "yo" 38 | }, 39 | { 40 | "appid": "id1", 41 | "id": 1, 42 | "name": "yo" 43 | }, 44 | ... 45 | ] 46 | } 47 | } 48 | ``` 49 | 50 | 51 | ## Index 52 | 53 | * [`fn byKey(arr, key)`](#fn-bykey) 54 | * [`fn byKeys(arr, keys)`](#fn-bykeys) 55 | 56 | ## Fields 57 | 58 | ### fn byKey 59 | 60 | ```ts 61 | byKey(arr, key) 62 | ``` 63 | 64 | `byKey` aggregates an array by the value of `key` 65 | 66 | 67 | ### fn byKeys 68 | 69 | ```ts 70 | byKeys(arr, keys) 71 | ``` 72 | 73 | `byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the 74 | aggregate one layer deeper. 75 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/array.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /array/ 3 | --- 4 | 5 | # array 6 | 7 | ```jsonnet 8 | local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" 9 | ``` 10 | 11 | `array` implements helper functions for processing arrays. 12 | 13 | ## Index 14 | 15 | * [`fn filterMapWithIndex(filter_func, map_func, arr)`](#fn-filtermapwithindex) 16 | * [`fn slice(indexable, index, end='null', step=1)`](#fn-slice) 17 | 18 | ## Fields 19 | 20 | ### fn filterMapWithIndex 21 | 22 | ```ts 23 | filterMapWithIndex(filter_func, map_func, arr) 24 | ``` 25 | 26 | `filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. 27 | 28 | `filter_func` and `map_func` function signature: `function(index, array_item)` 29 | 30 | 31 | ### fn slice 32 | 33 | ```ts 34 | slice(indexable, index, end='null', step=1) 35 | ``` 36 | 37 | `slice` works the same as `std.slice` but with support for negative index/end. -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/ascii.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /ascii/ 3 | --- 4 | 5 | # ascii 6 | 7 | ```jsonnet 8 | local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" 9 | ``` 10 | 11 | `ascii` implements helper functions for ascii characters 12 | 13 | ## Index 14 | 15 | * [`fn isLower(c)`](#fn-islower) 16 | * [`fn isNumber(c)`](#fn-isnumber) 17 | * [`fn isStringJSONNumeric(str)`](#fn-isstringjsonnumeric) 18 | * [`fn isStringNumeric(str)`](#fn-isstringnumeric) 19 | * [`fn isUpper(c)`](#fn-isupper) 20 | 21 | ## Fields 22 | 23 | ### fn isLower 24 | 25 | ```ts 26 | isLower(c) 27 | ``` 28 | 29 | `isLower` reports whether ASCII character `c` is a lower case letter 30 | 31 | ### fn isNumber 32 | 33 | ```ts 34 | isNumber(c) 35 | ``` 36 | 37 | `isNumber` reports whether character `c` is a number. 38 | 39 | ### fn isStringJSONNumeric 40 | 41 | ```ts 42 | isStringJSONNumeric(str) 43 | ``` 44 | 45 | `isStringJSONNumeric` reports whether string `s` is a number as defined by [JSON](https://www.json.org/json-en.html). 46 | 47 | ### fn isStringNumeric 48 | 49 | ```ts 50 | isStringNumeric(str) 51 | ``` 52 | 53 | `isStringNumeric` reports whether string `s` consists only of numeric characters. 54 | 55 | ### fn isUpper 56 | 57 | ```ts 58 | isUpper(c) 59 | ``` 60 | 61 | `isUpper` reports whether ASCII character `c` is a upper case letter -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /camelcase/ 3 | --- 4 | 5 | # camelcase 6 | 7 | ```jsonnet 8 | local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" 9 | ``` 10 | 11 | `camelcase` can split camelCase words into an array of words. 12 | 13 | ## Index 14 | 15 | * [`fn split(src)`](#fn-split) 16 | * [`fn toCamelCase(str)`](#fn-tocamelcase) 17 | 18 | ## Fields 19 | 20 | ### fn split 21 | 22 | ```ts 23 | split(src) 24 | ``` 25 | 26 | `split` splits a camelcase word and returns an array of words. It also supports 27 | digits. Both lower camel case and upper camel case are supported. It only supports 28 | ASCII characters. 29 | For more info please check: http://en.wikipedia.org/wiki/CamelCase 30 | Based on https://github.com/fatih/camelcase/ 31 | 32 | 33 | ### fn toCamelCase 34 | 35 | ```ts 36 | toCamelCase(str) 37 | ``` 38 | 39 | `toCamelCase` transforms a string to camelCase format, splitting words by the `-`, `_` or spaces. 40 | For example: `hello_world` becomes `helloWorld`. 41 | For more info please check: http://en.wikipedia.org/wiki/CamelCase 42 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/date.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /date/ 3 | --- 4 | 5 | # date 6 | 7 | ```jsonnet 8 | local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" 9 | ``` 10 | 11 | `time` provides various date related functions. 12 | 13 | ## Index 14 | 15 | * [`fn dayOfWeek(year, month, day)`](#fn-dayofweek) 16 | * [`fn dayOfYear(year, month, day)`](#fn-dayofyear) 17 | * [`fn isLeapYear(year)`](#fn-isleapyear) 18 | * [`fn parseRFC3339(input)`](#fn-parserfc3339) 19 | * [`fn toUnixTimestamp(year, month, day, hour, minute, second)`](#fn-tounixtimestamp) 20 | 21 | ## Fields 22 | 23 | ### fn dayOfWeek 24 | 25 | ```ts 26 | dayOfWeek(year, month, day) 27 | ``` 28 | 29 | `dayOfWeek` returns the day of the week for the given date. 0=Sunday, 1=Monday, etc. 30 | 31 | ### fn dayOfYear 32 | 33 | ```ts 34 | dayOfYear(year, month, day) 35 | ``` 36 | 37 | `dayOfYear` calculates the ordinal day of the year based on the given date. The range of outputs is 1-365 38 | for common years, and 1-366 for leap years. 39 | 40 | 41 | ### fn isLeapYear 42 | 43 | ```ts 44 | isLeapYear(year) 45 | ``` 46 | 47 | `isLeapYear` returns true if the given year is a leap year. 48 | 49 | ### fn parseRFC3339 50 | 51 | ```ts 52 | parseRFC3339(input) 53 | ``` 54 | 55 | `parseRFC3339` parses an RFC3339-formatted date & time string (like `2020-01-02T03:04:05Z`) into an object containing the 'year', 'month', 'day', 'hour', 'minute' and 'second fields. 56 | This is a limited implementation that does not support timezones (so it requires an UTC input ending in 'Z' or 'z') nor sub-second precision. 57 | The returned object has a `toUnixTimestamp()` method that can be used to obtain the unix timestamp of the parsed date. 58 | 59 | 60 | ### fn toUnixTimestamp 61 | 62 | ```ts 63 | toUnixTimestamp(year, month, day, hour, minute, second) 64 | ``` 65 | 66 | `toUnixTimestamp` calculates the unix timestamp of a given date. 67 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/inspect.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /inspect/ 3 | --- 4 | 5 | # inspect 6 | 7 | ```jsonnet 8 | local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" 9 | ``` 10 | 11 | `inspect` implements helper functions for inspecting Jsonnet 12 | 13 | ## Index 14 | 15 | * [`fn diff(input1, input2)`](#fn-diff) 16 | * [`fn filterKubernetesObjects(object, kind='')`](#fn-filterkubernetesobjects) 17 | * [`fn filterObjects(filter_func, x)`](#fn-filterobjects) 18 | * [`fn inspect(object, maxDepth)`](#fn-inspect) 19 | 20 | ## Fields 21 | 22 | ### fn diff 23 | 24 | ```ts 25 | diff(input1, input2) 26 | ``` 27 | 28 | `diff` returns a JSON object describing the differences between two inputs. It 29 | attemps to show diffs in nested objects and arrays too. 30 | 31 | Simple example: 32 | 33 | ```jsonnet 34 | local input1 = { 35 | same: 'same', 36 | change: 'this', 37 | remove: 'removed', 38 | }; 39 | 40 | local input2 = { 41 | same: 'same', 42 | change: 'changed', 43 | add: 'added', 44 | }; 45 | 46 | diff(input1, input2), 47 | ``` 48 | 49 | Output: 50 | ```json 51 | { 52 | "add +": "added", 53 | "change ~": "~[ this , changed ]", 54 | "remove -": "removed" 55 | } 56 | ``` 57 | 58 | 59 | ### fn filterKubernetesObjects 60 | 61 | ```ts 62 | filterKubernetesObjects(object, kind='') 63 | ``` 64 | 65 | `filterKubernetesObjects` implements `filterObjects` to return all Kubernetes objects in 66 | an array, assuming that Kubernetes object are characterized by having an 67 | `apiVersion` and `kind` field. 68 | 69 | The `object` argument can either be an object or an array, other types will be 70 | ignored. The `kind` allows to filter out a specific kind, if unset all kinds will 71 | be returned. 72 | 73 | 74 | ### fn filterObjects 75 | 76 | ```ts 77 | filterObjects(filter_func, x) 78 | ``` 79 | 80 | `filterObjects` walks a JSON tree returning all matching objects in an array. 81 | 82 | The `x` argument can either be an object or an array, other types will be 83 | ignored. 84 | 85 | 86 | ### fn inspect 87 | 88 | ```ts 89 | inspect(object, maxDepth) 90 | ``` 91 | 92 | `inspect` reports the structure of a Jsonnet object with a recursion depth of 93 | `maxDepth` (default maxDepth=10). 94 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /jsonpath/ 3 | --- 4 | 5 | # jsonpath 6 | 7 | ```jsonnet 8 | local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" 9 | ``` 10 | 11 | `jsonpath` implements helper functions to use JSONPath expressions. 12 | 13 | ## Index 14 | 15 | * [`fn convertBracketToDot(path)`](#fn-convertbrackettodot) 16 | * [`fn getJSONPath(source, path, default='null')`](#fn-getjsonpath) 17 | * [`fn parseFilterExpr(path)`](#fn-parsefilterexpr) 18 | 19 | ## Fields 20 | 21 | ### fn convertBracketToDot 22 | 23 | ```ts 24 | convertBracketToDot(path) 25 | ``` 26 | 27 | `convertBracketToDot` converts the bracket notation to dot notation. 28 | 29 | This function does not support escaping brackets/quotes in path keys. 30 | 31 | 32 | ### fn getJSONPath 33 | 34 | ```ts 35 | getJSONPath(source, path, default='null') 36 | ``` 37 | 38 | `getJSONPath` gets the value at `path` from `source` where path is a JSONPath. 39 | 40 | This is a rudimentary implementation supporting the slice operator `[0:3:2]` and 41 | partially supporting filter expressions `?(@.attr==value)`. 42 | 43 | 44 | ### fn parseFilterExpr 45 | 46 | ```ts 47 | parseFilterExpr(path) 48 | ``` 49 | 50 | `parseFilterExpr` returns a filter function `f(x)` for a filter expression `expr`. 51 | 52 | It supports comparisons (<, <=, >, >=) and equality checks (==, !=). If it doesn't 53 | have an operator, it will check if the `expr` value exists. 54 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/number.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /number/ 3 | --- 4 | 5 | # number 6 | 7 | ```jsonnet 8 | local number = import "github.com/jsonnet-libs/xtd/number.libsonnet" 9 | ``` 10 | 11 | `number` implements helper functions for processing number. 12 | 13 | ## Index 14 | 15 | * [`fn inRange(v, from, to)`](#fn-inrange) 16 | * [`fn maxInArray(arr, default=0)`](#fn-maxinarray) 17 | * [`fn minInArray(arr, default=0)`](#fn-mininarray) 18 | 19 | ## Fields 20 | 21 | ### fn inRange 22 | 23 | ```ts 24 | inRange(v, from, to) 25 | ``` 26 | 27 | `inRange` returns true if `v` is in the given from/to range.` 28 | 29 | ### fn maxInArray 30 | 31 | ```ts 32 | maxInArray(arr, default=0) 33 | ``` 34 | 35 | `maxInArray` finds the biggest number in an array 36 | 37 | ### fn minInArray 38 | 39 | ```ts 40 | minInArray(arr, default=0) 41 | ``` 42 | 43 | `minInArray` finds the smallest number in an array -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/string.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /string/ 3 | --- 4 | 5 | # string 6 | 7 | ```jsonnet 8 | local string = import "github.com/jsonnet-libs/xtd/string.libsonnet" 9 | ``` 10 | 11 | `string` implements helper functions for processing strings. 12 | 13 | ## Index 14 | 15 | * [`fn splitEscape(str, c, escape='\\')`](#fn-splitescape) 16 | 17 | ## Fields 18 | 19 | ### fn splitEscape 20 | 21 | ```ts 22 | splitEscape(str, c, escape='\\') 23 | ``` 24 | 25 | `split` works the same as `std.split` but with support for escaping the dividing 26 | string `c`. 27 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/docs/url.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: /url/ 3 | --- 4 | 5 | # url 6 | 7 | ```jsonnet 8 | local url = import "github.com/jsonnet-libs/xtd/url.libsonnet" 9 | ``` 10 | 11 | `url` provides functions to deal with URLs 12 | 13 | ## Index 14 | 15 | * [`fn encodeQuery(params)`](#fn-encodequery) 16 | * [`fn escapeString(str, excludedChars=[])`](#fn-escapestring) 17 | * [`fn join(splitObj)`](#fn-join) 18 | * [`fn parse(url)`](#fn-parse) 19 | 20 | ## Fields 21 | 22 | ### fn encodeQuery 23 | 24 | ```ts 25 | encodeQuery(params) 26 | ``` 27 | 28 | `encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string 29 | 30 | ### fn escapeString 31 | 32 | ```ts 33 | escapeString(str, excludedChars=[]) 34 | ``` 35 | 36 | `escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences 37 | 38 | ### fn join 39 | 40 | ```ts 41 | join(splitObj) 42 | ``` 43 | 44 | `join` joins URLs from the object generated from `parse` 45 | 46 | ### fn parse 47 | 48 | ```ts 49 | parse(url) 50 | ``` 51 | 52 | `parse` parses absolute and relative URLs. 53 | 54 | :///;parameters?# 55 | 56 | Inspired by Python's urllib.urlparse, following several RFC specifications. 57 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/main.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#': d.pkg( 5 | name='xtd', 6 | url='github.com/jsonnet-libs/xtd/main.libsonnet', 7 | help=||| 8 | `xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). 9 | 10 | This package serves as a test field for functions intended to be contributed to `std` 11 | in the future, but also provides a place for less general, yet useful utilities. 12 | |||, 13 | ), 14 | 15 | aggregate: (import './aggregate.libsonnet'), 16 | array: (import './array.libsonnet'), 17 | ascii: (import './ascii.libsonnet'), 18 | camelcase: (import './camelcase.libsonnet'), 19 | date: (import './date.libsonnet'), 20 | inspect: (import './inspect.libsonnet'), 21 | jsonpath: (import './jsonpath.libsonnet'), 22 | number: (import './number.libsonnet'), 23 | string: (import './string.libsonnet'), 24 | url: (import './url.libsonnet'), 25 | } 26 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/number.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#': d.pkg( 5 | name='number', 6 | url='github.com/jsonnet-libs/xtd/number.libsonnet', 7 | help='`number` implements helper functions for processing number.', 8 | ), 9 | 10 | '#inRange':: d.fn( 11 | '`inRange` returns true if `v` is in the given from/to range.`', 12 | [ 13 | d.arg('v', d.T.number), 14 | d.arg('from', d.T.number), 15 | d.arg('to', d.T.number), 16 | ] 17 | ), 18 | inRange(v, from, to): 19 | v > from && v <= to, 20 | 21 | '#maxInArray':: d.fn( 22 | '`maxInArray` finds the biggest number in an array', 23 | [ 24 | d.arg('arr', d.T.array), 25 | d.arg('default', d.T.number, default=0), 26 | ] 27 | ), 28 | maxInArray(arr, default=0): 29 | std.foldl( 30 | std.max, 31 | std.set(arr), 32 | default, 33 | ), 34 | 35 | '#minInArray':: d.fn( 36 | '`minInArray` finds the smallest number in an array', 37 | [ 38 | d.arg('arr', d.T.array), 39 | d.arg('default', d.T.number, default=0), 40 | ] 41 | ), 42 | minInArray(arr, default=0): 43 | std.foldl( 44 | std.min, 45 | std.set(arr), 46 | default, 47 | ), 48 | } 49 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/string.libsonnet: -------------------------------------------------------------------------------- 1 | local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; 2 | 3 | { 4 | '#': d.pkg( 5 | name='string', 6 | url='github.com/jsonnet-libs/xtd/string.libsonnet', 7 | help='`string` implements helper functions for processing strings.', 8 | ), 9 | 10 | // BelRune is a string of the Ascii character BEL which made computers ring in ancient times. 11 | // We use it as "magic" char to temporarily replace an escaped string as it is a non printable 12 | // character and thereby will unlikely be in a valid key by accident. Only when we include it. 13 | local BelRune = std.char(7), 14 | 15 | '#splitEscape':: d.fn( 16 | ||| 17 | `split` works the same as `std.split` but with support for escaping the dividing 18 | string `c`. 19 | |||, 20 | [ 21 | d.arg('str', d.T.string), 22 | d.arg('c', d.T.string), 23 | d.arg('escape', d.T.string, default='\\'), 24 | ] 25 | ), 26 | splitEscape(str, c, escape='\\'): 27 | std.map( 28 | function(i) 29 | std.strReplace(i, BelRune, escape + c), 30 | std.split( 31 | std.strReplace(str, escape + c, BelRune), 32 | c, 33 | ) 34 | ), 35 | } 36 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet: -------------------------------------------------------------------------------- 1 | local array = import '../array.libsonnet'; 2 | local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; 3 | 4 | local arr = std.range(0, 10); 5 | 6 | test.new(std.thisFile) 7 | 8 | + test.case.new( 9 | name='first two', 10 | test=test.expect.eq( 11 | actual=array.slice( 12 | arr, 13 | index=0, 14 | end=2, 15 | ), 16 | expected=[0, 1], 17 | ) 18 | ) 19 | + test.case.new( 20 | name='last two', 21 | test=test.expect.eq( 22 | actual=array.slice( 23 | arr, 24 | index=1, 25 | end=3, 26 | ), 27 | expected=[1, 2], 28 | ) 29 | ) 30 | + test.case.new( 31 | name='until end', 32 | test=test.expect.eq( 33 | actual=array.slice( 34 | arr, 35 | index=1 36 | ), 37 | expected=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 38 | ) 39 | ) 40 | + test.case.new( 41 | name='from beginning', 42 | test=test.expect.eq( 43 | actual=array.slice( 44 | arr, 45 | index=0, 46 | end=2 47 | ), 48 | expected=[0, 1], 49 | ) 50 | ) 51 | + test.case.new( 52 | name='negative start', 53 | test=test.expect.eq( 54 | actual=array.slice( 55 | arr, 56 | index=-2 57 | ), 58 | expected=[9, 10], 59 | ) 60 | ) 61 | + test.case.new( 62 | name='negative end', 63 | test=test.expect.eq( 64 | actual=array.slice( 65 | arr, 66 | index=0, 67 | end=-1 68 | ), 69 | expected=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 70 | ) 71 | ) 72 | + test.case.new( 73 | name='step', 74 | test=test.expect.eq( 75 | actual=array.slice( 76 | arr, 77 | index=0, 78 | end=5, 79 | step=2 80 | ), 81 | expected=[0, 2, 4], 82 | ) 83 | ) 84 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet: -------------------------------------------------------------------------------- 1 | local ascii = import '../ascii.libsonnet'; 2 | local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; 3 | 4 | test.new(std.thisFile) 5 | 6 | + test.case.new( 7 | name='all numeric', 8 | test=test.expect.eq( 9 | actual=ascii.isStringNumeric('123'), 10 | expected=true, 11 | ) 12 | ) 13 | 14 | + test.case.new( 15 | name='only beginning numeric', 16 | test=test.expect.eq( 17 | actual=ascii.isStringNumeric('123abc'), 18 | expected=false, 19 | ) 20 | ) 21 | 22 | + test.case.new( 23 | name='only end numeric', 24 | test=test.expect.eq( 25 | actual=ascii.isStringNumeric('abc123'), 26 | expected=false, 27 | ) 28 | ) 29 | 30 | + test.case.new( 31 | name='none numeric', 32 | test=test.expect.eq( 33 | actual=ascii.isStringNumeric('abc'), 34 | expected=false, 35 | ) 36 | ) 37 | 38 | + test.case.new( 39 | name='empty', 40 | test=test.expect.eq( 41 | actual=ascii.isStringNumeric(''), 42 | expected=true, 43 | ) 44 | ) 45 | 46 | + std.foldl( 47 | function(acc, str) 48 | acc 49 | + test.case.new( 50 | name='valid: ' + str, 51 | test=test.expect.eq( 52 | actual=ascii.isStringJSONNumeric(str), 53 | expected=true, 54 | ) 55 | ), 56 | [ 57 | '15', 58 | '1.5', 59 | '-1.5', 60 | '1e5', 61 | '1E5', 62 | '1.5e5', 63 | '1.5E5', 64 | '1.5e-5', 65 | '1.5E+5', 66 | ], 67 | {}, 68 | ) 69 | + std.foldl( 70 | function(acc, str) 71 | acc 72 | + test.case.new( 73 | name='invalid: ' + str, 74 | test=test.expect.eq( 75 | actual=ascii.isStringJSONNumeric(str), 76 | expected=false, 77 | ) 78 | ), 79 | [ 80 | '15e', 81 | '1.', 82 | '+', 83 | '+1E5', 84 | '.5', 85 | 'E5', 86 | 'e5', 87 | '15e5garbage', 88 | '1garbag5e5garbage', 89 | 'garbage15e5garbage', 90 | ], 91 | {}, 92 | ) 93 | -------------------------------------------------------------------------------- /vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 1, 3 | "dependencies": [ 4 | { 5 | "source": { 6 | "git": { 7 | "remote": "https://github.com/jsonnet-libs/testonnet.git", 8 | "subdir": "" 9 | } 10 | }, 11 | "version": "master" 12 | } 13 | ], 14 | "legacyImports": true 15 | } 16 | -------------------------------------------------------------------------------- /vendor/grafonnet: -------------------------------------------------------------------------------- 1 | github.com/grafana/grafonnet/gen/grafonnet-v11.1.0 -------------------------------------------------------------------------------- /vendor/xtd: -------------------------------------------------------------------------------- 1 | github.com/jsonnet-libs/xtd --------------------------------------------------------------------------------